Skip to content

Rspress 教程

欢迎来到 Rspress 教程!本教程将带你从零开始,循序渐进地学习 Rspress,一个基于 Rust 的现代化静态站点生成器。

什么是 Rspress?

Rspress 是一个快速、灵活且易于使用的静态站点生成器,专门为文档网站设计。它结合了 Rust 的高性能和现代前端技术,为开发者提供出色的开发体验。

主要特性

  • 极速性能 - 基于 Rust 构建,提供超快的构建速度
  • 📝 MDX 支持 - 在 Markdown 中使用 React 组件
  • 🎨 现代化主题 - 开箱即用的美观主题
  • 🔍 全文搜索 - 内置强大的搜索功能
  • 🌍 国际化 - 完善的多语言支持
  • 📱 响应式设计 - 完美适配各种设备
  • 🔌 插件系统 - 灵活的扩展能力

教程内容

基础篇

  1. Rspress 简介 - 了解 Rspress 的核心概念和优势
  2. 快速开始 - 创建你的第一个 Rspress 项目
  3. 约定式路由 - 理解 Rspress 的路由机制
  4. 导航栏与侧边栏 - 配置网站导航结构

进阶篇

  1. 自动生成导航 - 自动化导航配置
  2. MDX 及 React 组件 - 在文档中使用交互式组件
  3. 静态资源处理 - 管理图片、样式等资源
  4. 静态站点生成 (SSG/SSR) - 理解站点生成机制
  5. 国际化 (i18n) - 构建多语言文档站点
  6. 项目部署 - 将站点部署到生产环境

高级篇

  1. llms.txt - 为 AI 优化的文档索引
  2. 代码块与容器 - 丰富的内容展示方式
  3. 自定义页面 - 创建特殊页面布局
  4. 自定义主题 - 打造独特的视觉风格
  5. 多版本文档 - 管理不同版本的文档
  6. 内置组件 - 使用 Rspress 提供的组件
  7. 构建能力扩展 - 通过插件扩展功能
  8. 自定义搜索 - 定制搜索体验

适合人群

  • 🎓 想要学习现代文档工具的开发者
  • 📚 需要构建技术文档的团队
  • 🚀 追求极致性能的项目
  • 🌐 需要多语言支持的国际化项目

学习路径

如果你是完全的新手,建议按照以下顺序学习:

  1. Rspress 简介 开始,了解基本概念
  2. 跟随 快速开始 搭建第一个项目
  3. 学习基础配置(路由、导航栏、侧边栏)
  4. 掌握内容编写(MDX、代码块、组件)
  5. 深入高级特性(主题、插件、部署)

开始学习

准备好了吗?让我们从 Rspress 简介 开始这段学习之旅!

相关资源


提示

本教程会持续更新,确保内容与 Rspress 最新版本保持同步。建议收藏本页面以便后续查阅。