快速开始#

1. 初始化项目#

方式一：通过脚手架创建#

你可以通过 Rspress 脚手架命令来创建项目:

npm create rspress@latest

然后按照提示输入项目名称，即可创建一个 Rspress 项目。

方式二：手动创建#

首先，你可以通过以下命令创建一个新目录：

mkdir rspress-app && cd rspress-app

执行 npm init -y 来初始化一个项目。你可以使用 npm、yarn 或 pnpm 安装 Rspress:

npm install rspress typescript ts-node -D

然后通过如下命令创建文件:

mkdir docs && echo '# Hello World' > docs/index.md

在 package.json 中加上如下的脚本:

{
  "scripts": {
    "dev": "rspress dev",
    "build": "rspress build",
    "preview": "rspress preview"
  }
}

然后初始化一个配置文件 rspress.config.ts:

import { defineConfig } from 'rspress/config';

export default defineConfig({
  // 文档根目录
  root: 'docs',
});

同时新建 tsconfig.json，内容如下:

{
  "compilerOptions": {
    "esModuleInterop": true,
    "jsx": "react-jsx"
  }
}

2. 启动 Dev Server#

通过如下命令启动本地开发服务:

npm run dev

这样 Rspress 将启动开发服务。

3. 生产环境构建#

通过如下命令构建生产环境的产物:

npm run build

默认情况下，Rspress 将会把产物打包到 doc_build 目录。

4. 本地预览产物#

通过如下命令启动本地预览服务:

npm run preview

这样 Rspress 将启动产物预览服务。