#doc

rs doc 命令使用 Rspress 开发、构建和预览文档站点。

使用该命令前，请安装 @rspress/core：

npm install -D @rspress/core

yarn add -D @rspress/core

pnpm add -D @rspress/core

bun add -D @rspress/core

deno add -D npm:@rspress/core

#用法

rs doc [command] [root] [options]

该命令会加载通过 define.doc() 注册的文档配置。未指定子命令时，默认启动 Rspress 开发服务器。可选的 root 参数用于覆盖配置中的文档根目录。

#选项

rs doc 支持与对应 Rspress 命令相同的选项，具体说明请参见 Rspress CLI 文档。

示例：

# 启动开发服务器
rs doc

# 使用自定义文档根目录
rs doc ./documentation

# 使用 8080 端口启动开发服务器
rs doc --port 8080

#子命令

#build

rs doc build 用于构建生产环境的文档站点。

rs doc build

#preview

rs doc preview 用于在本地预览 rs doc build 生成的产物。

rs doc build
rs doc preview

#eject

rs doc eject 用于将 Rspress 内置主题组件复制到项目中进行自定义。不指定组件名称时，会列出所有可导出的组件。

rs doc eject

#配置

在 Rstack 配置文件中通过 define.doc() 配置文档站点。该 API 支持标准的 Rspress 配置：

import { define } from 'rstack';

define.doc({
  root: 'docs',
  title: 'My Site',
});