Quick start#

1. Initialize the project#

Method 1: create via CLI#

You can create a Rspress project using the create-rspress cli:

npm create rspress@latest

Input the project directory name, and then the cli will create the project for you.

Method 2: manual creation#

First, you can create a new directory with the following command:

mkdir rspress-app && cd rspress-app

Execute npm init -y to initialize a project. You can install Rspress using npm, pnpm, yarn or bun:

npm install rspress -D

Then create the file with the following command

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

Add the following script to package.json:

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

Then initialize a configuration file rspress.config.ts:

import { defineConfig } from 'rspress/config';

export default defineConfig({
  root: 'docs',
});

And then create tsconfig.json, add the following config:

{
  "compilerOptions": {
    "target": "ES2020",
    "lib": ["DOM", "ES2020"],
    "module": "ESNext",
    "jsx": "react-jsx",
    "noEmit": true,
    "strict": true,
    "skipLibCheck": true,
    "isolatedModules": true,
    "resolveJsonModule": true,
    "moduleResolution": "bundler",
    "useDefineForClassFields": true,
    "allowImportingTsExtensions": true
  },
  "include": ["docs", "theme", "rspress.config.ts"],
  "mdx": {
    "checkMdx": true
  }
}

2. Start dev server#

Start the local development service with the following command:

npm run dev

3. Build in production#

Build the production bundle with the following command :

npm run build

By default, Rspress will set doc_build as the output directory.

4. Preview in local environment#

Start the local preview service with the following command:

npm run preview