Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,419 changes: 229 additions & 1,190 deletions pnpm-lock.yaml

Large diffs are not rendered by default.

25 changes: 0 additions & 25 deletions rspress/basic/.gitignore

This file was deleted.

29 changes: 29 additions & 0 deletions rspress/basic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Rspress website

## Setup

Install the dependencies:

```bash
npm install
```
Comment on lines +5 to +9
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This README instructs npm install, but this repo is a pnpm workspace (root scripts use pnpm --filter ...). Using npm here can create an extra lockfile and different resolution; update the instructions to use pnpm (e.g. pnpm install at repo root and pnpm --filter @rspress-example/basic dev / pnpm dev).

Copilot uses AI. Check for mistakes.

## Get started

Start the dev server:

```bash
npm run dev
```

Build the website for production:

```bash
npm run build
```

Preview the production build locally:

```bash
npm run preview
```
16 changes: 0 additions & 16 deletions rspress/basic/docs/_meta.json

This file was deleted.

16 changes: 16 additions & 0 deletions rspress/basic/docs/_nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[
{
"text": "Guide",
"link": "/guide/start/introduction",
"activeMatch": "/guide/"
},
{
"text": "API",
"link": "/api/",
"activeMatch": "/api/"
},
{
"text": "Document",
"link": "https://rspress.rs/"
}
]
1 change: 1 addition & 0 deletions rspress/basic/docs/api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["index", "commands"]
7 changes: 7 additions & 0 deletions rspress/basic/docs/api/commands.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Commands

## dev

## build

## preview
6 changes: 6 additions & 0 deletions rspress/basic/docs/api/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: API Overview
overview: true
---

This is an API Overview page which outlines all the available APIs.
13 changes: 12 additions & 1 deletion rspress/basic/docs/guide/_meta.json
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
["index"]
[
{
"type": "dir-section-header",
"name": "start",
"label": "Getting Started"
},
{
"type": "dir-section-header",
"name": "use-mdx",
"label": "Markdown & MDX"
}
]
210 changes: 0 additions & 210 deletions rspress/basic/docs/guide/index.md

This file was deleted.

1 change: 1 addition & 0 deletions rspress/basic/docs/guide/start/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["introduction", "getting-started"]
51 changes: 51 additions & 0 deletions rspress/basic/docs/guide/start/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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:

```bash
npm run dev
```

:::tip

You can specify the port number or host with `--port` or `--host`, such as `rspress dev --port 8080 --host 0.0.0.0`.

:::

## Production build

Build the site for production:

```bash
npm run build
```

By default, Rspress will output to `doc_build` directory.

Comment on lines +34 to +37
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc mentions the build output is doc_build, but the per-example .gitignore files were removed and the repo root .gitignore does not ignore doc_build. This makes it easy to accidentally commit generated site output; add an ignore rule (either restore a package-level .gitignore or add a repo-level ignore like **/doc_build/).

Copilot uses AI. Check for mistakes.
## Preview

Preview the production build locally:

```bash
npm run preview
```

## Next steps

- Learn how to use [MDX & React Components](/guide/use-mdx/components) in your docs.
- Learn about [Code Blocks](/guide/use-mdx/code-blocks/) syntax highlighting and line highlighting.
- Learn about [Custom Containers](/guide/use-mdx/container) for tips, warnings, and more.
- Explore the full [Rspress documentation](https://rspress.rs/) for advanced features.
Loading
Loading