命令行工具(CLI)

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

一旦网站初始化之后,网站源码中将包含包管理器可调用的 Docusaurus 脚本:

package.json
{
// ...
"scripts": {
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy"
}
}

Docusaurus CLI 命令

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

docusaurus start

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

参数

名称默认值描述
--port3000指定开发服务器监听的端口
--hostlocalhost指定要使用的主机。例如,如果希望服务器可以从外部访问,则可以使用 --host 0.0.0.0
--hot-onlyfalse在构建失败的情况下,启用模块热替换而不进行页面刷新的方式作为后备。更多信息请见 这里
--no-openfalse不要在浏览器中自动打开页面。
--pollfalse在文件监视(watching)功能不能工作的环境中,使用文件轮询(polling)而不是监视(watching)的功能实现实时重新加载。更多信息请见 这里
important

请注意,某些功能(例如 anchor 链接)在开发环境中将无法使用,但在生产环境中能正常工作。

docusaurus build

为生产环境编译网站。

参数

名称默认值描述
--bundle-analyzerfalse利用 webpack bundle analyzer 分析 bundle。
--out-dirbuild相对于当前工作空间的新输出目录的完整路径。
--no-minifyfalse构建网站并且不对 JS/CSS bundle 进行压缩。

docusaurus swizzle

caution

在进入 Beta 阶段之前,我们强烈建议不要使用组件覆盖(swizzling of components)功能。由于组件的 API 一直在快速变化,并且可能会不断变化,直到我们达到 Beta 版本位置。如果可能的话,现阶段请使用默认外观,以免将来遭受潜在的痛苦。

根据自己的喜好,利用 docusaurus swizzle 更改任何 Docusaurus 主题的组件。

docusaurus swizzle <themeName> [componentName] [siteDir]
# Example (leaving out the siteDir to indicate this directory)
docusaurus swizzle @docusaurus/theme-classic DocSidebar

运行该命令会将相关主题文件复制到您的站点文件夹中。然后,您可以对其进行任何更改,Docusaurus 将使用修改过的版本而不是主题自带的内容。

参数

名称描述
themeName正在使用的主题的名称。
swizzleComponent需要覆盖的组件的名称。

如需取消自定义组件,只需删除自定义组件所对应的文件即可。

docusaurus deploy

将站点部署到 GitHub Pages。请查看 部署 章节的文档以了解更多信息。

参数

名称默认值描述
--out-dirbuild相对于当前工作空间的新输出目录的完整路径。
--skip-buildfalse略过构建步骤并部署网站。 使用自定义部署脚本时会很有用。
Last updated on by wangsai