#Getting started

#Project structure

After creating a project with create-rspress, you will get the following project structure:

• docs/ — The documentation source directory, configured via root in rspress.config.ts.
• docs/_nav.json — The navigation bar configuration.
• docs/guide/_meta.json — The sidebar configuration for the guide section.
• docs/public/ — Static assets directory.
• theme/ — Optional custom theme directory, generated when you choose the custom theme scaffold.
• rspress.config.ts — The Rspress configuration file.

#Development

Start the local development server:

npm run dev

#Production build

Build the site for production:

npm run build

By default, Rspress will output to doc_build directory.

#Preview

Preview the production build locally:

npm run preview

#Next steps

• Learn how to use MDX & React Components in your docs.
• Learn about Code Blocks syntax highlighting and line highlighting.
• Learn about Custom Containers for tips, warnings, and more.
• Explore the full Rspress documentation for advanced features.