命令行界面

Docusaurus 提供了一组脚本来帮助您生成、服务和部署您的网站。

一旦你的网站被引导启动，网站源代码将包含你可以用你的包管理器调用的Docusaurus脚本：

{
  // ...
  "scripts": {
    "docusaurus": "docusaurus",
    "start": "docusaurus start",
    "build": "docusaurus build",
    "swizzle": "docusaurus swizzle",
    "deploy": "docusaurus deploy",
    "clear": "docusaurus clear",
    "serve": "docusaurus serve",
    "write-translations": "docusaurus write-translations",
    "write-heading-ids": "docusaurus write-heading-ids"
  }
}

Docusaurus CLI 命令​

以下是Docusaurus CLI命令及其用法的列表：

docusaurus start [siteDir]​

使用Webpack Dev Server在本地构建并提供您网站的预览。

选项​

npm run start -- --host 0.0.0.0

yarn run start --host 0.0.0.0

pnpm run start --host 0.0.0.0

启用HTTPS​

有多种方式可以获取证书。我们将以mkcert为例。

1. 运行 mkcert localhost 以生成 localhost.pem + localhost-key.pem

2. 运行 mkcert -install 以将证书安装到您的信任存储中，并重新启动浏览器

3. 使用 Docusaurus HTTPS 环境变量启动应用程序：

HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start

4. 打开 https://localhost:3000/

docusaurus build [siteDir]​

为生产环境编译您的站点。

选项​

docusaurus swizzle [themeName] [componentName] [siteDir]​

Swizzle 一个主题组件以自定义它。

npm run swizzle [themeName] [componentName] [siteDir]

# Example (leaving out the siteDir to indicate this directory)
npm run swizzle @docusaurus/theme-classic Footer -- --eject

yarn swizzle [themeName] [componentName] [siteDir]

# Example (leaving out the siteDir to indicate this directory)
yarn swizzle @docusaurus/theme-classic Footer --eject

pnpm run swizzle [themeName] [componentName] [siteDir]

# Example (leaving out the siteDir to indicate this directory)
pnpm run swizzle @docusaurus/theme-classic Footer --eject

swizzle CLI 是交互式的，将引导您完成整个 swizzle 过程。

选项​

docusaurus deploy [siteDir]​

使用GitHub Pages部署您的站点。查看部署文档以获取更多详细信息。

选项​

docusaurus serve [siteDir]​

在本地提供您构建的网站。

docusaurus clear [siteDir]​

清除Docusaurus站点生成的资源、缓存、构建产物。

我们建议在报告错误之前、升级版本之后或您的Docusaurus网站出现问题时运行此命令。

docusaurus write-translations [siteDir]​

编写你需要翻译的JSON翻译文件。

默认情况下，文件被写入 website/i18n//...。

docusaurus write-heading-ids [siteDir] [files]​

为您的网站的Markdown文档添加显式标题ID。