API Reference

This section provides detailed information about the configuration options and CLI commands available in Rspress.

The API is designed to be simple, intuitive, and highly extensible.

Configuration

Rspress is configured via the rspress.config.ts file in the root of your project.

import { defineConfig } from 'rspress/config';

export default defineConfig({
  // Configuration options
});

Basic Config

Configure the title, description, and root directory of your documentation.

Theme Config

Customize the navigation bar, sidebar, and social links.

CLI Commands

Rspress provides a set of CLI commands to help you develop and build your documentation.

  • rspress dev: Start the development server.
  • rspress build: Build the documentation for production.
  • rspress preview: Preview the built documentation locally.