rspress日常更新流程

记录一下平时写博客、更新文章的标准流程。


一、写文章

1. 新建文件

docs/ 对应的分类目录下新建 .md 文件,例如:

docs/工具教程/新文章标题.md

如果是子分类目录下的文章:

docs/工具教程/AI Coding工具/新文章标题.md

不需要写 frontmatter(date 等),不需要改任何配置文件。第一行直接写 # 文章标题,侧边栏会自动识别。

2. 编写内容

第一行写 # 文章标题,Rspress 会自动把它作为页面标题和侧边栏文字。

图片放在 docs/public/ 目录下,引用时用 /图片名.png

示例:

# 文章标题

这里是正文内容。

二、文章分类

现有分类

分类目录说明
Agentdocs/Agent/大模型智能体开发
Python教程docs/Python教程/Python 工具链与实践
工具教程docs/工具教程/日常工具配置与使用
生活docs/生活/生活记录

新增文章到已有分类

直接在对应目录下新建 .md 文件即可,无需改配置。侧边栏会自动扫描目录生成。

新增子分类

  1. 在分类目录下新建文件夹,例如 docs/工具教程/新子分类/
  2. 在该文件夹下新建 .md 文件即可

新增顶级分类

  1. docs/ 下新建目录,新建 index.md 作为分类首页,第一行写 # 分类名称
  2. docs/_nav.json 中添加一条导航项:
{ "text": "新分类", "link": "/新分类/" }

配置说明

  • docs/_nav.json — 顶部导航栏配置
  • rspress.config.ts — 站点基础配置(标题、图标、主题等)
  • 侧边栏由目录结构和 .md 文件的 # 标题 自动生成,无需手动维护

三、提交流程

1. 本地预览

npm run dev

浏览器打开 http://localhost:5173/ 预览效果。

2. 提交代码

git add docs/
git commit -m "feat: 添加新文章《文章标题》"
git push

3. 等待部署

推送到 GitHub 后,CI/CD 会自动构建并部署。