This website is built using Docusaurus 2, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
$ 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.
When adding new content or re-organizing existing content, please be sure to update the following:
- Sidebar file -
sidebars.js - Redirects file -
netlify.toml
To create a top-level, noncollapsible category like Getting Started, add the following to the docs array:
docs: [
// ...
{
type: 'category',
label: 'Tea Drinks',
collapsible: false,
className: 'category-not-collapsible',
items: [
// Add the IDs of your new category's pages here
'tea-drinks/intro',
],
}
]To add a subcategory, add the category object to the items array:
docs: [
// ...
{
type: 'category',
label: 'Tea Drinks',
collapsible: false,
className: 'category-not-collapsible',
items: [
'tea-drinks/intro',
// Add your new subcategory here
{
type: 'category',
label: 'Hot Drinks',
collapsed: true,
items: [
// Add the IDs of your new subcategory's pages here
'tea-drinks/hot-drinks/intro',
],
},
],
}
]To create a top-level, collapsible category like Access Control, add the following to the docs array:
docs: [
// ...
{
type: 'category',
label: 'Coffee Drinks',
collapsed: true,
items: [
// Add the IDs of your new category's pages here
'coffee-drinks/intro',
],
}
]If you are changing the path of a page, you will need to add a redirect to the netlify.toml file. For example, if you are changing the path of docs/tea-drinks/intro.md to docs/tea-drinks/tea-drinks-intro.md, you will need to add the following to the netlify.toml file:
[[redirects]]
from = "/docs/tea-drinks/intro"
to = "/docs/tea-drinks/tea-drinks-intro"
status = 301
force = falseBefore running any yarn scripts, be sure to do the following:
cp .env.example .envand fill in the secrets.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent