docs/README.md
This directory contains the documentation website built with Docusaurus.
cd docs
pnpm install
# From docs directory
pnpm start
# Or from root directory
pnpm dev:docs
Open http://localhost:3000 to view the documentation.
# From docs directory
pnpm build
# Or from root directory
pnpm build:docs
The built files will be in the build/ directory.
# From docs directory
pnpm serve
# Or from root directory
pnpm serve:docs
docs/
├── docs/ # Markdown documentation files
│ ├── intro.md # Introduction page
│ ├── installation.md
│ ├── config/ # Configuration docs
│ ├── advanced/ # Advanced topics
│ └── cli/ # CLI reference
├── src/ # React components and pages
│ ├── components/ # Custom React components
│ ├── pages/ # Additional pages
│ ├── css/ # Custom CSS
│ └── theme/ # Docusaurus theme customization
├── static/ # Static assets (images, etc.)
├── i18n/ # Internationalization files
├── docusaurus.config.ts # Docusaurus configuration
└── sidebars.ts # Documentation sidebar structure
Create a new Markdown file in the docs/ directory and add it to sidebars.ts.
Add React components to src/pages/.
Edit src/css/custom.css.
Documentation supports both English and Chinese.
docs/ and src/i18n/zh/docusaurus-plugin-content-docs/current/To add Chinese translations:
i18n/zh/docusaurus-plugin-content-docs/current/The documentation can be deployed to:
See Docusaurus deployment docs for details.