17da3677d9
* docs: i18n sidebar * docs: `code-group` to `tabs` * docs: admonitions use default title * docs: fix route * docs: fix build * docs: fix add-docs admonitions * docs: unwrap `details` wrapped content * docs: mention no i18n switch in dev mode * docs: fix add-docs rendering * docs: fix typo |
||
|---|---|---|
| .. | ||
| docs | ||
| i18n | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package.json | ||
| pnpm-lock.yaml | ||
| sidebars.js | ||
| tsconfig.json | ||
README.md
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ pnpm
Local Development
$ pnpm 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.
Build
$ pnpm build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true pnpm deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> pnpm 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.