跳到主要内容

命令行界面 (CLI)

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

网站启动后，网站源代码将包含您可以使用包管理器调用的 Docusaurus 脚本：

package.json
{
  // ...
  "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 在本地构建和提供网站预览。

选项​

名称默认值描述
--port3000指定开发服务器的端口。
--hostlocalhost指定要使用的主机。例如，如果您希望您的服务器可以从外部访问，您可以使用 --host 0.0.0.0。
--locale指定要使用的网站区域设置。
--hot-onlyfalse启用热模块替换，无需页面刷新，作为构建失败时的后备方案。更多信息 在此 。
--no-openfalse不要自动在浏览器中打开页面。
--configundefinedDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js
--poll [optionalIntervalMs]false使用文件轮询而不是监视以进行实时重新加载，作为在监视不起作用的环境中的后备方案。更多信息 在此 。
--no-minifyfalse构建网站而不最小化 JS/CSS 包。
信息

请注意，某些功能（例如锚链接）在开发中不起作用。该功能将在生产环境中按预期工作。

网络开发

当从远程服务器或虚拟机（例如 GitHub Codespaces）转发端口 3000 时，您可以在 0.0.0.0 上运行开发服务器以使其侦听本地 IP。

npm 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
  1. 打开 https://localhost:3000/

docusaurus build [siteDir]​

编译您的网站以用于生产。

选项​

名称默认值描述
--dev以开发模式构建网站，包括完整的 React 错误消息。
--bundle-analyzerfalse使用 webpack bundle analyzer 分析您的包。
--out-dirbuild新输出目录的完整路径，相对于当前工作区。
--configundefinedDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js
--locale以指定的区域设置构建网站。如果未指定，则构建所有已知的区域设置。
--no-minifyfalse构建网站而不最小化 JS/CSS 包。
信息

对于 CSS 包的高级压缩，我们使用 高级 cssnano 预设 （以及其他几个 PostCSS 插件）和 clean-css 的 2 级优化 。如果由于这种高级 CSS 压缩导致您发现 CSS 损坏，请使用环境变量 USE_SIMPLE_CSS_MINIFIER=true 来使用 默认 cssnano 预设 来压缩 CSS。如果您遇到 CSS 压缩错误，请 提交问题 。

您可以使用环境变量 SKIP_HTML_MINIFICATION=true 跳过 HTML 压缩。

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

替换 主题组件以自定义它。

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

# 示例（省略 siteDir 以指示此目录）
npm run swizzle @docusaurus/theme-classic Footer -- --eject

swizzle CLI 是交互式的，它将指导您完成整个 替换过程 。

选项​

名称描述
themeName要从中替换的主题的名称。
componentName要替换的主题组件的名称。
--list显示可用于替换的组件
--eject弹出 主题组件
--wrap包装 主题组件
--danger允许立即替换不安全的组件
--typescript替换 TypeScript 变体组件
--configDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js
注意

由于内部重构，不安全的组件发生重大更改的风险更高。

docusaurus deploy [siteDir]​

使用 GitHub Pages 部署您的网站。查看有关 部署 的文档以了解更多详细信息。

选项​

名称默认值描述
--locale以指定的区域设置部署网站。如果未指定，则部署所有已知的区域设置。
--out-dirbuild新输出目录的完整路径，相对于当前工作区。
--skip-buildfalse在不构建网站的情况下部署网站。当使用自定义部署脚本时，这可能很有用。
--target-dir.要部署到的目标目录的路径。
--configundefinedDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js

docusaurus serve [siteDir]​

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

名称默认值描述
--port3000使用指定的端口
--dirbuild输出目录的完整路径，相对于当前工作区
--buildfalse提供服务前构建网站
--configundefinedDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js
--hostlocalhost指定要使用的主机。例如，如果您希望您的服务器可以从外部访问，您可以使用 --host 0.0.0.0。
--no-openfalse locally, true in CI不要打开浏览器窗口到服务器位置。

docusaurus clear [siteDir]​

清除 Docusaurus 网站生成的资源、缓存、构建工件。

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

docusaurus write-translations [siteDir]​

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

默认情况下，文件写入 website/i18n/<defaultLocale>/...。

名称默认值描述
--locale<defaultLocale>定义要将 JSON 文件的翻译写入哪个区域设置文件夹
--overridefalse覆盖现有的翻译消息
--configundefinedDocusaurus 配置文件的路径，默认为 [siteDir]/docusaurus.config.js
--messagePrefix''允许为每个翻译消息添加前缀，以帮助您突出显示未翻译的字符串

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

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

名称默认值描述
files所有插件使用的 MD 文件您希望写入标题 ID 的文件。
--maintain-casefalse保持标题的大小写，否则全部小写。
--overwritefalse覆盖现有的标题 ID。
编辑此页
最后由 HomeUbuntu 于 更新