create-rspress 2.0.13 → 2.0.14

package/template-i18n/docs/en/guide/use-mdx/components.mdx

@@ -0,0 +1,51 @@
+---
+description: Use Markdown, MDX, React components, and Rspress built-in components in documentation pages.
+---
+
+# MDX & React components
+
+Rspress supports not only Markdown but also [MDX](https://mdxjs.com/), a powerful way to develop content.
+
+## Markdown
+
+MDX is a superset of Markdown, which means you can write Markdown files as usual. For example:
+
+```md
+# Hello world
+```
+
+## Use components
+
+When you want to use React components in Markdown files, you should name your files with `.mdx` extension.
+
+```mdx
+// docs/index.mdx
+import { CustomComponent } from './custom';
+
+# Hello world
+
+<CustomComponent />
+```
+
+## Use Rspress built-in components
+
+import { Tabs, Tab } from '@rspress/core/theme';
+
+<Tabs>
+
+<Tab label="foo.js">
+
+```js
+console.log('foo');
+```
+
+</Tab>
+<Tab label="bar.js">
+
+```js
+console.log('bar');
+```
+
+</Tab>
+
+</Tabs>

package/template-i18n/docs/en/guide/use-mdx/container.md

@@ -0,0 +1,37 @@
+---
+description: Create Rspress custom containers for tips, info, warnings, dangers, details, and custom titles.
+---
+
+# Container
+
+You can use the `:::` syntax to create custom containers and support custom titles.
+
+## Examples
+
+:::tip
+This is a `block` of type `tip`
+:::
+
+:::info
+This is a `block` of type `info`
+:::
+
+:::warning
+This is a `block` of type `warning`
+:::
+
+:::danger
+This is a `block` of type `danger`
+:::
+
+::: details
+This is a `block` of type `details`
+:::
+
+:::tip Custom Title
+This is a `block` of `Custom Title`
+:::
+
+:::tip{title="Custom Title"}
+This is a `block` of `Custom Title`
+:::

package/template-i18n/docs/en/index.md

@@ -0,0 +1,44 @@
+---
+description: Rspress starter homepage with guide, MDX, search, AI, SSG, and theme customization links.
+pageType: home
+
+hero:
+  name: My Site
+  text: A cool website!
+  tagline: This is the tagline
+  actions:
+    - theme: brand
+      text: Quick Start
+      link: /guide/start/introduction
+    - theme: alt
+      text: GitHub
+      link: https://github.com/web-infra-dev/rspress
+  image:
+    src: /rspress-icon.png
+    alt: Logo
+features:
+  - title: Blazing fast build speed
+    details: The core compilation module is based on the Rust front-end toolchain, providing a more ultimate development experience.
+    icon: 🏃🏻‍♀️
+    link: /guide/start/introduction
+  - title: Support for MDX content writing
+    details: MDX is a powerful way to write content, allowing you to use React components in Markdown.
+    icon: 📦
+    link: /guide/use-mdx/components
+  - title: Built-in full-text search
+    details: Automatically generates a full-text search index for you during construction, providing out-of-the-box full-text search capabilities.
+    icon: 🎨
+    link: https://rspress.rs/guide/advanced/custom-search
+  - title: AI-friendly
+    details: Generate llms.txt and Markdown files compliant with the llms.txt specification through SSG-MD, making it easier for large language models to understand and use your documentation.
+    icon: 🤖
+    link: https://rspress.rs/guide/basic/ssg-md
+  - title: Static site generation
+    details: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
+    icon: 🌈
+    link: https://rspress.rs/guide/basic/ssg
+  - title: Providing multiple custom capabilities
+    details: Through its extension mechanism, you can easily extend theme UI and build process.
+    icon: 🔥
+    link: https://rspress.rs/guide/basic/custom-theme
+---

package/template-i18n/docs/zh/_nav.json

@@ -0,0 +1,16 @@
+[
+  {
+    "text": "指南",
+    "link": "/guide/start/introduction",
+    "activeMatch": "/guide/"
+  },
+  {
+    "text": "API",
+    "link": "/api/",
+    "activeMatch": "/api/"
+  },
+  {
+    "text": "文档",
+    "link": "https://rspress.rs/"
+  }
+]

package/template-i18n/docs/zh/api/_meta.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "file",
+    "name": "index",
+    "label": "API 概览"
+  },
+  {
+    "type": "file",
+    "name": "commands",
+    "label": "命令"
+  }
+]

package/template-i18n/docs/zh/api/commands.mdx

@@ -0,0 +1,11 @@
+---
+description: Rspress 本地开发、生产构建和本地预览脚本的命令参考。
+---
+
+# 命令
+
+## dev
+
+## build
+
+## preview

package/template-i18n/docs/zh/api/index.mdx

@@ -0,0 +1,7 @@
+---
+title: API 概览
+description: Rspress 入门模板 API 区域和可用参考页面的概览。
+overview: true
+---
+
+这是一个 API 概览页面，用于列出所有可用 API。

package/template-i18n/docs/zh/guide/_meta.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "dir-section-header",
+    "name": "start",
+    "label": "快速开始"
+  },
+  {
+    "type": "dir-section-header",
+    "name": "use-mdx",
+    "label": "Markdown 与 MDX"
+  }
+]

package/template-i18n/docs/zh/guide/start/_meta.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "file",
+    "name": "introduction",
+    "label": "介绍"
+  },
+  {
+    "type": "file",
+    "name": "getting-started",
+    "label": "快速开始"
+  }
+]

package/template-i18n/docs/zh/guide/start/getting-started.md

@@ -0,0 +1,55 @@
+---
+description: 了解 Rspress 项目结构、本地开发、生产构建、本地预览和后续学习路径。
+---
+
+# 快速开始
+
+## 项目结构
+
+使用 `create-rspress` 创建项目后，你会得到以下项目结构：
+
+- `docs/`：文档源码目录，通过 `rspress.config.ts` 中的 `root` 配置。
+- `docs/_nav.json`：导航栏配置。
+- `docs/guide/_meta.json`：指南区域的侧边栏配置。
+- `docs/public/`：静态资源目录。
+- `theme/`：可选的自定义主题目录，在选择自定义主题模板时生成。
+- `rspress.config.ts`：Rspress 配置文件。
+
+## 本地开发
+
+启动本地开发服务器：
+
+```bash
+npm run dev
+```
+
+:::tip
+
+你可以使用 `--port` 或 `--host` 指定端口号或主机，例如 `rspress dev --port 8080 --host 0.0.0.0`。
+
+:::
+
+## 生产构建
+
+构建生产站点：
+
+```bash
+npm run build
+```
+
+默认情况下，Rspress 会输出到 `doc_build` 目录。
+
+## 预览
+
+本地预览生产构建结果：
+
+```bash
+npm run preview
+```
+
+## 下一步
+
+- 学习如何在文档中使用 [MDX 与 React 组件](/guide/use-mdx/components)。
+- 了解 [代码块](/guide/use-mdx/code-blocks/) 的语法高亮和行高亮。
+- 学习用于提示、警告等内容的 [自定义容器](/guide/use-mdx/container)。
+- 浏览完整的 [Rspress 文档](https://rspress.rs/zh/) 了解高级能力。

package/template-i18n/docs/zh/guide/start/introduction.md

@@ -0,0 +1,19 @@
+---
+description: 介绍 Rspress 的构建性能、AI 原生输出、MDX 支持、基础能力和扩展机制。
+---
+
+# 介绍
+
+Rspress 是一个基于 [Rsbuild](https://rsbuild.rs/) 的静态站点生成器，使用 React 框架渲染。它内置默认文档主题，你可以用 Rspress 快速构建文档站点。
+
+## 为什么选择 Rspress
+
+- **构建性能**。核心编译模块基于 Rust 前端工具链，提供毫秒级启动和更极致的开发体验。
+- **AI 原生**。技术文档不仅服务人类读者，也可以通过 SSG-MD 更好地被 AI 理解和使用。
+- **MDX 支持**。MDX 是一种强大的内容编写方式，可以在 Markdown 中使用 React 组件。
+- **基础能力**。包括全文搜索、国际化、多版本支持、组件库文档等。
+- **可扩展性**。提供内置插件系统，支持通过插件 API 扩展 Rspress。
+
+## 试用 Rspress
+
+前往 [快速开始](/guide/start/getting-started) 了解如何使用 Rspress 构建文档站点。

package/template-i18n/docs/zh/guide/use-mdx/_meta.json

@@ -0,0 +1,17 @@
+[
+  {
+    "type": "file",
+    "name": "components",
+    "label": "MDX 与 React 组件"
+  },
+  {
+    "type": "dir",
+    "name": "code-blocks",
+    "label": "代码块"
+  },
+  {
+    "type": "file",
+    "name": "container",
+    "label": "容器"
+  }
+]

package/template-i18n/docs/zh/guide/use-mdx/code-blocks/_meta.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "file",
+    "name": "title",
+    "label": "标题"
+  },
+  {
+    "type": "file",
+    "name": "meta",
+    "label": "元信息"
+  }
+]

package/template-i18n/docs/zh/guide/use-mdx/code-blocks/index.mdx

@@ -0,0 +1,13 @@
+---
+description: 使用 Shiki 为 Rspress 代码块配置语法高亮和自动语言处理。
+---
+
+# 代码块
+
+Rspress 使用 [Shiki](https://shiki.style) 在编译时进行语法高亮，这意味着运行时性能更好。
+
+使用多种语言的代码块时，对应语言会在编译时自动检测，运行时包体积不会增加。支持的编程语言请参考 [Shiki 支持语言列表](https://shiki.style/languages)。
+
+```js
+console.log('Hello World');
+```

package/template-i18n/docs/zh/guide/use-mdx/code-blocks/meta.md

@@ -0,0 +1,11 @@
+---
+description: 为 Rspress 代码块添加行号、换行和标题等元信息。
+---
+
+# 元信息
+
+除了标题，我们还有一些其他元信息属性。
+
+```ts lineNumbers wrapCode title="example.ts"
+const longLine = 'This code block has line numbers, code wrapping, and a title';
+```

package/template-i18n/docs/zh/guide/use-mdx/code-blocks/title.md

@@ -0,0 +1,9 @@
+---
+description: 使用 Markdown 代码围栏元信息为 Rspress 代码块添加文件标题。
+---
+
+# 标题
+
+```js title="foo.js"
+console.log('Hello World');
+```

package/template-i18n/docs/zh/guide/use-mdx/components.mdx

@@ -0,0 +1,51 @@
+---
+description: 在文档页面中使用 Markdown、MDX、React 组件和 Rspress 内置组件。
+---
+
+# MDX 与 React 组件
+
+Rspress 不仅支持 Markdown，还支持 [MDX](https://mdxjs.com/)，这是一种强大的内容开发方式。
+
+## Markdown
+
+MDX 是 Markdown 的超集，这意味着你可以像往常一样编写 Markdown 文件。例如：
+
+```md
+# Hello world
+```
+
+## 使用组件
+
+当你想在 Markdown 文件中使用 React 组件时，应该使用 `.mdx` 扩展名命名文件。
+
+```mdx
+// docs/index.mdx
+import { CustomComponent } from './custom';
+
+# Hello world
+
+<CustomComponent />
+```
+
+## 使用 Rspress 内置组件
+
+import { Tabs, Tab } from '@rspress/core/theme';
+
+<Tabs>
+
+<Tab label="foo.js">
+
+```js
+console.log('foo');
+```
+
+</Tab>
+<Tab label="bar.js">
+
+```js
+console.log('bar');
+```
+
+</Tab>
+
+</Tabs>

package/template-i18n/docs/zh/guide/use-mdx/container.md

@@ -0,0 +1,37 @@
+---
+description: 创建 Rspress 自定义容器，用于提示、信息、警告、危险、详情和自定义标题。
+---
+
+# 容器
+
+你可以使用 `:::` 语法创建自定义容器，并支持自定义标题。
+
+## 示例
+
+:::tip
+这是一个 `tip` 类型的 `block`
+:::
+
+:::info
+这是一个 `info` 类型的 `block`
+:::
+
+:::warning
+这是一个 `warning` 类型的 `block`
+:::
+
+:::danger
+这是一个 `danger` 类型的 `block`
+:::
+
+::: details
+这是一个 `details` 类型的 `block`
+:::
+
+:::tip Custom Title
+这是一个 `Custom Title` 的 `block`
+:::
+
+:::tip{title="Custom Title"}
+这是一个 `Custom Title` 的 `block`
+:::

package/template-i18n/docs/zh/index.md

@@ -0,0 +1,44 @@
+---
+description: Rspress 入门模板首页，包含指南、MDX、搜索、AI、SSG 和主题定制入口。
+pageType: home
+
+hero:
+  name: 我的站点
+  text: 一个很酷的网站！
+  tagline: 这是网站的副标题
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /zh/guide/start/introduction
+    - theme: alt
+      text: GitHub
+      link: https://github.com/web-infra-dev/rspress
+  image:
+    src: /rspress-icon.png
+    alt: Logo
+features:
+  - title: 极速构建
+    details: 核心编译模块基于 Rust 前端工具链，提供更极致的开发体验。
+    icon: 🏃🏻‍♀️
+    link: /zh/guide/start/introduction
+  - title: 支持 MDX 内容编写
+    details: MDX 是一种强大的内容编写方式，可以在 Markdown 中使用 React 组件。
+    icon: 📦
+    link: /zh/guide/use-mdx/components
+  - title: 内置全文搜索
+    details: 构建时自动生成全文搜索索引，提供开箱即用的全文搜索能力。
+    icon: 🎨
+    link: https://rspress.rs/zh/guide/advanced/custom-search
+  - title: AI 友好
+    details: 通过 SSG-MD 生成符合 llms.txt 规范的 llms.txt 和 Markdown 文件，让大语言模型更容易理解和使用你的文档。
+    icon: 🤖
+    link: https://rspress.rs/zh/guide/basic/ssg-md
+  - title: 静态站点生成
+    details: 在生产环境中自动构建为静态 HTML 文件，可以轻松部署到任意位置。
+    icon: 🌈
+    link: https://rspress.rs/zh/guide/basic/ssg
+  - title: 提供多种自定义能力
+    details: 通过扩展机制，你可以轻松扩展主题 UI 和构建流程。
+    icon: 🔥
+    link: https://rspress.rs/zh/guide/basic/custom-theme
+---

package/template-i18n/rspress.config.ts

@@ -0,0 +1,37 @@
+import * as path from 'node:path';
+import { defineConfig } from '@rspress/core';
+
+export default defineConfig({
+  root: path.join(__dirname, 'docs'),
+  title: 'My Site',
+  description: 'A multilingual Rspress documentation site.',
+  lang: 'en',
+  icon: '/rspress-icon.png',
+  logo: {
+    light: '/rspress-light-logo.png',
+    dark: '/rspress-dark-logo.png',
+  },
+  locales: [
+    {
+      lang: 'en',
+      label: 'English',
+      title: 'My Site',
+      description: 'A multilingual Rspress documentation site.',
+    },
+    {
+      lang: 'zh',
+      label: '简体中文',
+      title: '我的站点',
+      description: '一个多语言 Rspress 文档站点。',
+    },
+  ],
+  themeConfig: {
+    socialLinks: [
+      {
+        icon: 'github',
+        mode: 'link',
+        content: 'https://github.com/web-infra-dev/rspress',
+      },
+    ],
+  },
+});

package/template-i18n-theme/docs/en/_nav.json

@@ -0,0 +1,16 @@
+[
+  {
+    "text": "Guide",
+    "link": "/guide/start/introduction",
+    "activeMatch": "/guide/"
+  },
+  {
+    "text": "API",
+    "link": "/api/",
+    "activeMatch": "/api/"
+  },
+  {
+    "text": "Document",
+    "link": "https://rspress.rs/"
+  }
+]

package/template-i18n-theme/docs/en/api/_meta.json

@@ -0,0 +1 @@
+["index", "commands"]

package/template-i18n-theme/docs/en/api/commands.mdx

@@ -0,0 +1,11 @@
+---
+description: Command reference for Rspress development, production build, and local preview scripts.
+---
+
+# Commands
+
+## dev
+
+## build
+
+## preview

package/template-i18n-theme/docs/en/api/index.mdx

@@ -0,0 +1,7 @@
+---
+title: API Overview
+description: Overview page for the Rspress starter API section and available reference pages.
+overview: true
+---
+
+This is an API Overview page which outlines all the available APIs.

package/template-i18n-theme/docs/en/guide/_meta.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "dir-section-header",
+    "name": "start",
+    "label": "Getting Started"
+  },
+  {
+    "type": "dir-section-header",
+    "name": "use-mdx",
+    "label": "Markdown & MDX"
+  }
+]

package/template-i18n-theme/docs/en/guide/start/_meta.json

@@ -0,0 +1 @@
+["introduction", "getting-started"]

package/template-i18n-theme/docs/en/guide/start/getting-started.md

@@ -0,0 +1,55 @@
+---
+description: Set up an Rspress project, run local development, build production output, and choose next docs topics.
+---
+
+# 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.
+
+## 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.

package/template-i18n-theme/docs/en/guide/start/introduction.md

@@ -0,0 +1,19 @@
+---
+description: Introduction to Rspress features, including build performance, AI-native output, MDX, and extensibility.
+---
+
+# Introduction
+
+Rspress is a static site generator based on [Rsbuild](https://rsbuild.rs/), rendered with the React framework. It comes with a default documentation theme, and you can quickly build a documentation site with Rspress.
+
+## Why Rspress
+
+- **Build Performance**. The core compilation module is based on the Rust front-end toolchain, providing millisecond-level startup and a more ultimate development experience.
+- **AI-native**. Technical documentation not only serves human readers but can also be better understood and utilized by AI through SSG-MD.
+- **MDX Support**. MDX is a powerful way to write content, allowing you to use React components in Markdown.
+- **Basic Capabilities**. Including full-text search, internationalization, multi-version support, component library documentation, etc.
+- **Extensibility**. Provides a built-in plugin system, supports extending Rspress through plugin API.
+
+## Try Rspress
+
+Go to [Getting Started](/guide/start/getting-started) to learn how to use Rspress to build a documentation site.

package/template-i18n-theme/docs/en/guide/use-mdx/_meta.json

@@ -0,0 +1 @@
+["components", { "type": "dir", "name": "code-blocks" }, "container"]

package/template-i18n-theme/docs/en/guide/use-mdx/code-blocks/_meta.json

@@ -0,0 +1 @@
+["title", "meta"]