Skip to content

如何新增一篇文章

这套知识库的核心用法:你出话题 + 资料,AI 照模板调研成稿。三步就够。

三步走

第 1 步:复制模板到对应分类

_templates/文章模板.md 复制一份,放进对应分类目录、起个英文短文件名:

  • AI 领域 → ai/你的文件名.md
  • 行业知识 → industry/你的文件名.md(目录已留好)
  • 想要新分类?新建一个目录即可(如 product/)。
bash
# 示例:在 ai 分类下新建一篇
cp _templates/文章模板.md ai/rag-explained.md

第 2 步:把"出稿提示词"发给 AI

把下面这段整段复制给 AI(Claude / 任意能联网调研的 AI),把方括号内容换成你的:

请帮我写一篇知识库文章,主题:[你的主题,例如"RAG 检索增强生成是什么"]

参考资料(请据实引用、不要编造):

  • [资料链接 1]
  • [资料链接 2]

严格按这个文件的结构和规则写:_templates/文章模板.md。要点:

  1. 专业 + 通俗双层:每个概念既给准确定义,又配日常类比和真实例子。
  2. 结构化优先:对比用表格,流程/关系用 Mermaid 图(一图一概念)。
  3. 图文并茂、精炼、说人话,面向没有相关背景的读者。
  4. 术语先用一句大白话翻译。
  5. 教程类常用区块按需选用,"反思/应用"不强制。

直接输出完整 Markdown(含 frontmatter),我会保存到 [分类/文件名].md

AI 出稿后,存进第 1 步建好的文件。

第 3 步:在侧边栏加一行

打开 .vitepress/config.ts,在对应分类的 items 里加一行:

ts
{ text: '文章显示名', link: '/ai/你的文件名' },

保存即可——本地预览会自动刷新出来。

本地看效果

bash
npm run docs:dev      # 起本地服务,浏览器开提示的地址(默认 http://localhost:5173)
npm run docs:build    # 构建一次,检查有没有死链 / 报错

小提醒

  • 文件名用英文/拼音短横线(如 rag-explained.md),中文标题写在 frontmatter 的 title 里。
  • 图想画什么直接用 Mermaid 文字写,不用画图工具——flowchart 画流程、sequenceDiagram 画时序。
  • 拿不准格式?翻第一篇 ai/feishu-cli-vs-mcp.md 当样板。

以后可以更省事(暂未做,记一笔)

  • 文章变多后,可加 vitepress-sidebar 插件自动生成侧边栏,连第 3 步都省了。
  • 格式稳定后,可把第 2 步那段"出稿提示词"固化成一个一键命令/技能。