快速开始

项目结构

使用 create-rspress 创建项目后,你会得到以下项目结构:

  • docs/:文档源码目录,通过 rspress.config.ts 中的 root 配置。
  • docs/_nav.json:导航栏配置。
  • docs/guide/_meta.json:指南区域的侧边栏配置。
  • docs/public/:静态资源目录。
  • theme/:可选的自定义主题目录,在选择自定义主题模板时生成。
  • rspress.config.ts:Rspress 配置文件。

本地开发

启动本地开发服务器:

npm run dev
Tip

你可以使用 --port--host 指定端口号或主机,例如 rspress dev --port 8080 --host 0.0.0.0

生产构建

构建生产站点:

npm run build

默认情况下,Rspress 会输出到 doc_build 目录。

预览

本地预览生产构建结果:

npm run preview

下一步