For AI agents: the complete documentation index is available at https://rspress.rs/llms.txt, the full documentation bundle is available at https://rspress.rs/llms-full.txt, and this page is available as Markdown at https://rspress.rs/index.md.

English

中文
English

Rspress

Lightning Fast Static Site Generator

Made for humans. Understood by AI

Introduction Quick Start

npm

yarn

pnpm

bun

deno

npm create rspress@latest

Rspress

English

Hello Rspress

index.mdx

# Hello Rspress

```ts title="index.ts"
console.log('Hello Rspress');
```

Blazing fast build speed

Built on the Rust-powered front-end toolchain for a faster development experience.

Support for MDX

MDX is a powerful way to write content, allowing you to use React components in Markdown.

Built-in full-text search

Automatically generates a full-text search index during builds, with search available out of the box.

AI-friendly

Use SSG-MD to generate llms.txt-compliant indexes and Markdown files so large language models can better understand your docs.

Static site generation

Builds static HTML files for production so your site can be deployed anywhere.

Flexible customization

Extend the theme UI and build process through Rspress extension APIs.

SSG-MD · llms.txt

HTML for humans, Markdown for AI

One source, two outputs. Every page is built as a fast HTML page for readers (SSG) and a clean Markdown twin for LLMs (SSG-MD), with site-wide llms.txt and llms-full.txt following the llms.txt standard.

Every page gets a .md twin — swap .html for .md in the URL
llms.txt index and llms-full.txt, ordered by your navigation
MDX components render to clean Markdown, not syntax noise

Explore SSG-MD

doc_build

SSGSSG-MD

guide

start

introduction.html

introduction.md

llms.txtindex

llms-full.txtfull

# Introduction

Rspress is a lightning fast static site

generator based on Rsbuild.

```ts title="index.ts"

console.log('Hello Rspress');

```

_nav.json / _meta.json

Navigation that writes itself

Declare the navbar and sidebar next to your content. Rspress generates them from _nav.json and _meta.json — with hot reload, so structure changes show up instantly.

Navbar from _nav.json, per-directory sidebars from _meta.json
Order, labels, icons, section headers, dividers and custom links
Page metadata stays in frontmatter, next to the content

Learn about auto nav & sidebar

docs/guide/_meta.json

[
  {
    "type": "section-header",
    "label": "Guide"
  },
  "introduction",
  "quick-start",
  {
    "type": "dir",
    "name": "advanced"
  }
]

Guide

Introduction

Quick Start

Advanced

Plugins & Themes

Extend the build, shape the theme

Hook into every stage with the plugin system, and tailor the look from CSS variables to fully ejected components.

Official plugins for search, sitemap, API docs, previews and more
Theme via CSS variables, layout slots, or rspress eject
Use the rspress-custom-theme skill to customize your theme with an AI agent

Start customizing

@rspress/plugin-*

Preview Playground Algolia Twoslash Typedoc Sitemap RSS Your plugin

theme/index.tsx · slots

beforeNavTitle

beforeSidebar

beforeDocContent

Rstack

The fast, unified JavaScript toolchain for developers and agents

Rspack

A fast Rust-based bundler for the web, with a modernized webpack API

rspack.rs

Rsbuild

A fast, extensible build tool for modern web development, powered by Rspack

rsbuild.rs

Rslib

An Rsbuild-based library development tool for creating libraries and UI components

rslib.rs

Rspress

An Rsbuild-based static site generator for creating documentation sites

rspress.rs

Rsdoctor

An AI-friendly build analyzer that makes the build process transparent

rsdoctor.rs

Rstest

A JavaScript testing framework powered by Rspack, with a Jest-compatible API

rstest.rs

Rslint

A high-performance, ESLint-compatible linter for JavaScript and TypeScript

rslint.rs