close
Rspress
  • 中文

      • 命令

      通过本章节，你可以了解到 Rspress 内置的命令有哪些，以及如何使用这些命令。

      rspress dev

      rspress dev 命令用于启动一个本地开发服务器，提供一个文档进行预览和调试的开发环境。

      Usage: rspress dev [root] [options]

Options:
  root                  指定文档根目录，默认为当前工作目录下的 docs 目录，可选
  -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
  --port <port>         指定端口号
  --host <host>         指定 host
  --base <base>         指定部署基础路径，并覆盖 config.base 配置
  -h, --help            显示命令帮助

      rspress build

      rspress build 命令用于构建出针对生产环境的文档产物。

      Usage: rspress build [root] [options]

Options:
  root                  指定文档根目录，默认为当前工作目录下的 docs 目录，可选
  -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
  --base <base>         指定部署基础路径，并覆盖 config.base 配置
  -h, --help            显示命令帮助

      rspress preview

      rspress preview 命令用于在本地预览 rspress build 命令构建出的产物。

      Usage: rspress preview [root] [options]

Options:
  root                  指定文档根目录，默认为当前工作目录下的 docs 目录，可选
  -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
  --port <port>         指定端口号
  --host <host>         指定 host
  --base <base>         指定部署基础路径，并覆盖 config.base 配置
  -h, --help            显示命令帮助

      rspress eject

      rspress eject 命令会将内置主题组件拷贝到你的项目中，便于自定义。

      Usage: rspress eject [component]

Arguments:
  component             （可选）要导出的主题组件名；留空则列出所有可导出的组件

      组件会被放置到 theme/components/<ComponentName> 目录下。请在 theme/index.tsx 中重新导出该组件以使用你的自定义版本。