-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(v2): add Facebook Docusaurus 2 template #2124
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 0 additions & 7 deletions
7
packages/docusaurus-init/templates/classic/src/pages/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 0 additions & 7 deletions
7
packages/docusaurus-init/templates/classic/src/pages/styles.module.css
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Website | ||
|
||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. | ||
|
||
### Installation | ||
|
||
``` | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
|
||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy | ||
``` | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |
11 changes: 11 additions & 0 deletions
11
packages/docusaurus-init/templates/facebook/blog/2019-05-28-hola.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: hola | ||
title: Hola | ||
author: Gao Wei | ||
author_title: Docusaurus Core Team | ||
author_url: https://github.com/wgao19 | ||
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4 | ||
tags: [hola, docusaurus] | ||
--- | ||
|
||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet |
17 changes: 17 additions & 0 deletions
17
packages/docusaurus-init/templates/facebook/blog/2019-05-29-hello-world.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
id: hello-world | ||
title: Hello | ||
author: Endilie Yacop Sucipto | ||
author_title: Maintainer of Docusaurus | ||
author_url: https://github.com/endiliey | ||
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4 | ||
tags: [hello, docusaurus] | ||
--- | ||
|
||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/). | ||
|
||
<!--truncate--> | ||
|
||
This is a test post. | ||
|
||
A whole bunch of other information. |
13 changes: 13 additions & 0 deletions
13
packages/docusaurus-init/templates/facebook/blog/2019-05-30-welcome.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
id: welcome | ||
title: Welcome | ||
author: Yangshun Tay | ||
author_title: Front End Engineer @ Facebook | ||
author_url: https://github.com/yangshun | ||
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4 | ||
tags: [facebook, hello, docusaurus] | ||
--- | ||
|
||
Blog features are powered by the blog plugin. Simple add files to the `blog` directory. It supports tags as well! | ||
|
||
Delete the whole directory if you don't want the blog features. As simple as that! |
168 changes: 168 additions & 0 deletions
168
packages/docusaurus-init/templates/facebook/docs/doc1.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
--- | ||
id: doc1 | ||
title: Style Guide | ||
sidebar_label: Style Guide | ||
--- | ||
|
||
You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). | ||
|
||
## Markdown Syntax | ||
|
||
To serve as an example page when styling markdown based Docusaurus sites. | ||
|
||
## Headers | ||
|
||
# H1 - Create the best documentation | ||
|
||
## H2 - Create the best documentation | ||
|
||
### H3 - Create the best documentation | ||
|
||
#### H4 - Create the best documentation | ||
|
||
##### H5 - Create the best documentation | ||
|
||
###### H6 - Create the best documentation | ||
|
||
--- | ||
|
||
## Emphasis | ||
|
||
Emphasis, aka italics, with _asterisks_ or _underscores_. | ||
|
||
Strong emphasis, aka bold, with **asterisks** or **underscores**. | ||
|
||
Combined emphasis with **asterisks and _underscores_**. | ||
|
||
Strikethrough uses two tildes. ~~Scratch this.~~ | ||
|
||
--- | ||
|
||
## Lists | ||
|
||
1. First ordered list item | ||
1. Another item ⋅⋅\* Unordered sub-list. | ||
1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list | ||
1. And another item. | ||
|
||
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). | ||
|
||
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.) | ||
|
||
- Unordered list can use asterisks | ||
|
||
* Or minuses | ||
|
||
- Or pluses | ||
|
||
--- | ||
|
||
## Links | ||
|
||
[I'm an inline-style link](https://www.google.com) | ||
|
||
[I'm an inline-style link with title](https://www.google.com "Google's Homepage") | ||
|
||
[I'm a reference-style link][arbitrary case-insensitive reference text] | ||
|
||
[I'm a relative reference to a repository file](../blob/master/LICENSE) | ||
|
||
[You can use numbers for reference-style link definitions][1] | ||
|
||
Or leave it empty and use the [link text itself]. | ||
|
||
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com> and sometimes example.com (but not on Github, for example). | ||
|
||
Some text to show that the reference links can follow later. | ||
|
||
[arbitrary case-insensitive reference text]: https://www.mozilla.org | ||
[1]: http://slashdot.org | ||
[link text itself]: http://www.reddit.com | ||
|
||
--- | ||
|
||
## Images | ||
|
||
Here's our logo (hover to see the title text): | ||
|
||
Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1') | ||
|
||
Reference-style: ![alt text][logo] | ||
|
||
[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2' | ||
|
||
--- | ||
|
||
## Code | ||
|
||
```javascript | ||
var s = 'JavaScript syntax highlighting'; | ||
alert(s); | ||
``` | ||
|
||
```python | ||
s = "Python syntax highlighting" | ||
print s | ||
``` | ||
|
||
``` | ||
No language indicated, so no syntax highlighting. | ||
But let's throw in a <b>tag</b>. | ||
``` | ||
|
||
```js {2} | ||
function highlightMe() { | ||
console.log('This line can be highlighted!'); | ||
} | ||
``` | ||
|
||
--- | ||
|
||
## Tables | ||
|
||
Colons can be used to align columns. | ||
|
||
| Tables | Are | Cool | | ||
| ------------- | :-----------: | -----: | | ||
| col 3 is | right-aligned | \$1600 | | ||
| col 2 is | centered | \$12 | | ||
| zebra stripes | are neat | \$1 | | ||
|
||
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. | ||
|
||
| Markdown | Less | Pretty | | ||
| -------- | --------- | ---------- | | ||
| _Still_ | `renders` | **nicely** | | ||
| 1 | 2 | 3 | | ||
|
||
--- | ||
|
||
## Blockquotes | ||
|
||
> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. | ||
|
||
Quote break. | ||
|
||
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote. | ||
|
||
--- | ||
|
||
## Inline HTML | ||
|
||
<dl> | ||
<dt>Definition list</dt> | ||
<dd>Is something people use sometimes.</dd> | ||
|
||
<dt>Markdown in HTML</dt> | ||
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd> | ||
</dl> | ||
|
||
--- | ||
|
||
## Line Breaks | ||
|
||
Here's a line for us to start with. | ||
|
||
This line is separated from the one above by two newlines, so it will be a _separate paragraph_. | ||
|
||
This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
id: doc2 | ||
title: Document Number 2 | ||
--- | ||
|
||
This is a link to [another document.](doc3.md) This is a link to an [external page.](http://www.example.com) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think maybe we shouldnt the last updated time & author by default. This slows build down (like a LOT) and I think its nicer to give them an impression that "Wow, docusaurus 2 is fast". For newly init site (and lot of our user) does not use git yet, so they're going to see "Sorry, this requires git" error also. Only if they need it they will need to enable it.
and the editUrl is also pointing to the wrong repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok I'll remove the last updated time and author display.
This is intended to give them the right default value (if they create a
website
folder at the root of their repo). We don't know their repo so it's never going to be right.