Center of Front

外观

如何新增一篇知识 ​

三分钟教程：写一篇笔记 = 选模板 → 填内容 → 放对目录 → 登记侧边栏。

第一步：选对目录 ​

按「你会在什么时候回来查它」决定放哪。对照 AGENTS.md 里的目录表，或看这个库怎么用。

第二步：套用三种模板之一 ​

模板一：知识对比型 ​

适合：架构选型、方案对比、工具选择（你举的「看架构优劣」就是这种）。

markdown
# 文章标题

## 是什么
一两句话说清楚这个东西解决什么问题。

## 各方案对比
| 方案 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| A | … | … | … |
| B | … | … | … |

## 怎么选
给未来的自己一个直接的结论/决策清单。

## 代码示例（可选）
最小可运行示例。

参考成品：应用形态对比

模板二：代码片段型 ​

适合：即取即用的技巧、踩坑解法。

markdown
# 片段名称

## 适用场景
什么时候需要它。

## 代码
（完整可复制的代码块）

## 注意事项
容易踩的坑、边界情况。

参考成品：CSS 技巧片段

模板三：资源收藏型 ​

适合：网站、工具、灵感站收藏。

markdown
# 资源名称

**链接**：<https://example.com>

## 为什么值得收藏
一句话说清楚它好在哪、你打算什么时候用它。

参考成品：精选资源大清单

第三步：登记侧边栏 ​

打开 docs/.vitepress/config.mts，找到对应分区的 sidebar，加一行：

ts
{ text: '文章标题', link: '/分区/文件名' }

保存后侧边栏自动更新，全文搜索也会自动收录这篇文章。

命名与书写约定 ​

  • 文件名：英文 kebab-case（state-management.md），标题写中文
  • 正文语气：像给未来的自己写笔记，有结论、直接、不抄书
  • 善用提示块：:::: tip 放结论，:::: warning 放坑，:::: danger 放严禁事项
  • 每篇控制在能 5 分钟读完的长度；写不短就拆成两篇