-
-
Notifications
You must be signed in to change notification settings - Fork 15.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate website to Docusaurus 2 (#3635)
* Migrate website to Docusaurus 2 * Tweak styling to better match original site - Shrank padding and border radius for code snippets - Made category chevrons closed=right and open=down - Added transition for category chevrons - Forced links in code snippets to inherit link color * Restructure index page sales pitch content based on RTK layout Co-authored-by: Mark Erikson <[email protected]>
- Loading branch information
1 parent
c270330
commit 011ac72
Showing
96 changed files
with
21,793 additions
and
9,260 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| [build] | ||
| base = "website" | ||
| publish = "website/build" | ||
| command = "npm run build" |
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,20 @@ | ||
| # dependencies | ||
| /node_modules | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # generated files | ||
| .docusaurus | ||
| .cache-loader | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
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 |
|---|---|---|
| @@ -1,198 +1,33 @@ | ||
| This website was created with [Docusaurus](https://docusaurus.io/). | ||
| # Website | ||
|
|
||
| # What's In This Document | ||
| This website is built using Docusaurus 2, a modern static website generator. | ||
|
|
||
| - [Get Started in 5 Minutes](#get-started-in-5-minutes) | ||
| - [Directory Structure](#directory-structure) | ||
| - [Editing Content](#editing-content) | ||
| - [Adding Content](#adding-content) | ||
| - [Full Documentation](#full-documentation) | ||
| ### Installation | ||
|
|
||
| # Get Started in 5 Minutes | ||
|
|
||
| 1. Make sure all the dependencies for the website are installed: | ||
|
|
||
| ```sh | ||
| # Install dependencies | ||
| $ yarn | ||
| ``` | ||
|
|
||
| 2. Run your dev server: | ||
|
|
||
| ```sh | ||
| # Start the site | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| ## Directory Structure | ||
|
|
||
| Your project file structure should look something like this | ||
|
|
||
| ``` | ||
| my-docusaurus/ | ||
| docs/ | ||
| doc-1.md | ||
| doc-2.md | ||
| doc-3.md | ||
| website/ | ||
| blog/ | ||
| 2016-3-11-oldest-post.md | ||
| 2017-10-24-newest-post.md | ||
| core/ | ||
| node_modules/ | ||
| pages/ | ||
| static/ | ||
| css/ | ||
| img/ | ||
| package.json | ||
| sidebar.json | ||
| siteConfig.js | ||
| ``` | ||
|
|
||
| # Editing Content | ||
|
|
||
| ## Editing an existing docs page | ||
|
|
||
| Edit docs by navigating to `docs/` and editing the corresponding document: | ||
|
|
||
| `docs/doc-to-be-edited.md` | ||
|
|
||
| ```markdown | ||
| --- | ||
| id: page-needs-edit | ||
| title: This Doc Needs To Be Edited | ||
| --- | ||
|
|
||
| Edit me... | ||
| ``` | ||
|
|
||
| For more information about docs, click [here](https://docusaurus.io/docs/en/navigation) | ||
|
|
||
| ## Editing an existing blog post | ||
|
|
||
| Edit blog posts by navigating to `website/blog` and editing the corresponding post: | ||
|
|
||
| `website/blog/post-to-be-edited.md` | ||
|
|
||
| ```markdown | ||
| --- | ||
| id: post-needs-edit | ||
| title: This Blog Post Needs To Be Edited | ||
| --- | ||
|
|
||
| Edit me... | ||
| $ yarn | ||
| ``` | ||
|
|
||
| For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) | ||
|
|
||
| # Adding Content | ||
|
|
||
| ## Adding a new docs page to an existing sidebar | ||
|
|
||
| 1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`: | ||
|
|
||
| ```md | ||
| --- | ||
| id: newly-created-doc | ||
| title: This Doc Needs To Be Edited | ||
| --- | ||
| ### Local Development | ||
|
|
||
| My new content here.. | ||
| ``` | ||
|
|
||
| 1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`: | ||
|
|
||
| ```javascript | ||
| // Add newly-created-doc to the Getting Started category of docs | ||
| { | ||
| "docs": { | ||
| "Getting Started": [ | ||
| "quick-start", | ||
| "newly-created-doc" // new doc here | ||
| ], | ||
| ... | ||
| }, | ||
| ... | ||
| } | ||
| $ yarn start | ||
| ``` | ||
|
|
||
| For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation) | ||
| This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ## Adding a new blog post | ||
| ### Build | ||
|
|
||
| 1. Make sure there is a header link to your blog in `website/siteConfig.js`: | ||
|
|
||
| `website/siteConfig.js` | ||
|
|
||
| ```javascript | ||
| headerLinks: [ | ||
| ... | ||
| { blog: true, label: 'Blog' }, | ||
| ... | ||
| ] | ||
| ``` | ||
|
|
||
| 2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`: | ||
|
|
||
| `website/blog/2018-05-21-New-Blog-Post.md` | ||
|
|
||
| ```markdown | ||
| --- | ||
| author: Frank Li | ||
| authorURL: https://twitter.com/foobarbaz | ||
| authorFBID: 503283835 | ||
| title: New Blog Post | ||
| --- | ||
|
|
||
| Lorem Ipsum... | ||
| $ yarn build | ||
| ``` | ||
|
|
||
| For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) | ||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ## Adding items to your site's top navigation bar | ||
| ### Deployment | ||
|
|
||
| 1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`: | ||
|
|
||
| `website/siteConfig.js` | ||
|
|
||
| ```javascript | ||
| { | ||
| headerLinks: [ | ||
| ... | ||
| /* you can add docs */ | ||
| { doc: 'my-examples', label: 'Examples' }, | ||
| /* you can add custom pages */ | ||
| { page: 'help', label: 'Help' }, | ||
| /* you can add external links */ | ||
| { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' }, | ||
| ... | ||
| ], | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation) | ||
|
|
||
| ## Adding custom pages | ||
|
|
||
| 1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`: | ||
| 1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element: | ||
|
|
||
| `website/siteConfig.js` | ||
|
|
||
| ```javascript | ||
| { | ||
| headerLinks: [ | ||
| ... | ||
| { page: 'my-new-custom-page', label: 'My New Custom Page' }, | ||
| ... | ||
| ], | ||
| ... | ||
| } | ||
| $ GIT_USER=<Your GitHub username> USE_SSH=1 yarn deploy | ||
| ``` | ||
|
|
||
| For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages). | ||
|
|
||
| # Full Documentation | ||
|
|
||
| Full documentation can be found on the [website](https://docusaurus.io/). | ||
| 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. |
Oops, something went wrong.