知识库写作规范(docs/knowledge/*.md)
「Claude 知识库」的正文写在 docs/knowledge/<slug>.md(原生 markdown),元数据在 config/knowledge.ts。 本文件是新增文章的执行规范,改文章只改这两处 + 跑生成脚本。
加一篇文章的流程
- 写
docs/knowledge/<slug>.md(frontmatter + 正文,模板见下)。 - 在
config/knowledge.ts的knowledge数组里加一条元数据(slug 与文件名一致)。 - 跑
npm run gen:og:knowledge生成分享卡片。 - 跑
npm run gen:routes同步_redirects与llms.txt。 - 在
scripts/check_dist.mjs与scripts/verify_build.py的PAGES里加路由。 npm run build && npm run verify && npm run check:links。
markdown 模板
markdown
---
layout: doc
knowledge: true
title: <H1,含目标长尾词,≤ 30 字>
description: <≤ 110 字,含主关键词 + 一句话结论>
date: 2026-10-XX
category: start | connect | cost | troubleshoot | reference | news
kicker: <页头短标签,如 Claude Code>
head:
- - meta
- property: og:title
content: <title> · Claude 知识库
- - meta
- property: og:description
content: <description>
---
# <H1,与 frontmatter title 一致>
> **一句话答案**:<40–80 字,直接回答标题的问题>
<2–3 段展开适用范围与前提>
## <H2:第一个方面>
<先给结论段(1–2 句独立成段),再展开>
### <H3:细分点>
...
## 常见问题
### <问题 1>
<直接答案,40 字以内>
## 相关阅读
- [使用教程](/guide):五步从卡密到跑起来
- [常见问题](/faq):限速与退款规则写作规范(GEO)
- 标题含目标长尾词,中文口语,不用「详解」「全解析」「一文读懂」。
- 首段是答案,不写「在当今 XX 时代」式开场。
- 每个 h2 首句即结论,独立成段。
- 具体数字(并发 20 / 60 次每分钟 / 300k token 每分钟 / 200k 上下文)只在
/faq、/unlimited出现,正文链接过去。 - 时效性事实标注「截至 2026-10-XX」或改成「以 CC Switch『获取模型列表』的实际返回为准」。
- 内链锚文本用真实关键词(「CC Switch 一键导入配置」而不是「点这里」),每篇至少 3 条站内互链(
/guide、/faq、/pricing、/unlimited)。 - 素材页的表格被压成连续文本行,引用时重排成真表格。
- 配置示例用
bash /json 代码块,不截图。 - 不出现工程口吻(「在 config 里改」);不出现素材站品牌名、链接、折扣数字。
- 图片首批不用;需要时必须登记进
theme/components/GuideShot.vue静态 import 表(图片不能放docs/)。
素材边界
素材在 site/archive/knowledge_source_20261008/(aiprimetech.io 抓取正文,仅作选题与事实核对)。 全部中文原创改写,不逐句翻译;素材的句子、例子、结构都不照搬。涉及版本号、模型名、价格的必须核对官方文档并标注日期。