docusaurus 命令

常用示例

说明

Docusaurus is a static site generator optimized for documentation websites. It uses React for the UI, Markdown/MDX for content, and provides features like versioning, i18n, and search out of the box. Sites are configured via docusaurus.config.js, defining metadata, themes, plugins, and navigation. Content lives in docs/ for documentation and blog/ for blog posts. The development server provides hot reloading. Production builds generate static HTML, CSS, and JavaScript that can be hosted anywhere. Built-in deployment support targets GitHub Pages.

参数

start --port _n_

Start development server (default port 3000).

build --out-dir _path_

Build static site for production.

serve --port _n_

Serve built site locally.

deploy

Deploy to GitHub Pages.

clear

Clear generated files and caches.

swizzle _theme_ _component_

Eject or wrap a theme component for customization (interactive).

docs:version _version_

Tag the current docs as a new version snapshot.

write-translations

Extract translatable strings to JSON translation files.

write-heading-ids

Add explicit heading IDs to Markdown documents.

--locale _locale_

Specify locale for the command.

--config _path_

Use a custom configuration file.

--out-dir _path_

Custom output directory for build (default: build/).