CLI Commands · Docusaurus

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。一些常见的命令如下:

yarn run start : 从本地服务器生成并且维护这个网站
yarn run examples : 创建示例配置文件

从命令行运行

这些脚本可以使用 Yarn 或 npm 来运行。如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。简单的命令，它告诉 Docusaurus 运行 Docusaurus-start 脚本, 生成站点并启动服务器, 通常是这样使用的:

yarn run start

也可以使用 npm 调用相同的脚本:

npm run start

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

使用参数

一些命令支持可选参数例如，为了在8080端口上启动服务，您可以在运行 start 指定 --port 端口：

yarn run start -- port 8080

同样，使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 后加上 -- 指定启动端口:

npm run start -- --port 8080

配置

这些脚本是在 website/package.json 文件的 "scripts" ，是安装过程中自动生成的。如果在设置的时候需要帮助, 请参阅安装指南。

Docusaurus 提供了一些默认的映射脚本, 允许您按照 Node 约定运行命令。您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次输入 docusaurus-start。

参考

`docusaurus-build`

指令︰ build

可选项	默认	说明
`--skip-image-compression`	`false`	忽略图片资源压缩。通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
`--skip-next-release`	`false`	启用版本管理时，跳过下一个版本文档。这不会为 `/docs` 目录中的文档生成 HTML 文件。

生成静态站点，必要时会应用翻译。适用于部署前构建站点。

另请参阅 docusaurus-start。

`docusaurus-examples`

指令：examples

参数	默认	说明
`<feature>`	-	指定附加功能 `translations` 或 `versions`，以生成附加功能的额外文件。

示例

docusaurus-示例 <feature>

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

`docusaurus-publish`

指令：publish-gh-pages

构建静态页面，然后在 GitHub Pages 上部署静态网站。此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

GIT_USER：部署仓库的所有者。
USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

示例

GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages

The following environment variables are set by CircleCI during the build process.

CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

`docusaurus-rename-version`

Alias: rename-version

Renames an existing version of the docs to a new version name.

参数	默认	说明
`<currentVersion>`	-	需要被重命名的版本。
`<newVersion>`	-	重命名后的版本。

示例

docusaurus-rename-version <currentVersion> <newVersion>

See the Versioning guide to learn more.

`docusaurus-start`

Alias: start.

This command will build the static website, apply translations if necessary, and then start a local server.

可选项	默认	说明
`--port <number>`	`3000`	网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
`--host <host>`	`localhost`	使用本地主机。例如，你希望你的服务可以被外部访问，可以使用-host 0.0.0.0.
`--watch`	-	是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。默认值为 true。使用 `--no-watch`禁用此功能。

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

$ BROWSER=firefox yarn start

`docusaurus-version <version>`

Alias: version

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

See the Versioning guide to learn more.

`docusaurus-write-translations`

Alias: write-translations

把用英文需要被翻译的字符串写到 website/i18n/en.json 文件中。 The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.