知识库
更新于 #总览#写作规范#导航

别称标识 又称 标牌、标识牌、指示牌

这是知识库内容的写作样板页:每个组件都活体演示一遍,并在下方给出「用法」注意点。新写或改写任意一章时,照这里的风格对齐,整站质量就能保持统一、达到文档级。改版前先读《知识库学习路径》建立全局观。

提示卡 callout(6 种语义)

用修饰类切换语义;需要标题时加 .callout__title。一句话能说清的提示,直接放 .callout__body 即可。

info(默认蓝)

普通说明、中性提示。

✅ 正向 / 推荐做法。

⚠️ 注意 / 易错点。

🚫 禁止 / 高危操作。

★ 方法论 / 关键结论。

📌 补充说明。

徽章 badge(7 变体)

行内小标签,用于状态 / 版本 / 分类。变体:--soft / --gold / --green / --red / --navy / --outline / --solid。

草稿 已发布 推荐 高危 v8 待审 新

步骤 steps / 时间线 timeline

.steps 用于有序操作;.timeline 用于带状态的时间节点(--done 绿 / --now 金)。

  1. 第一步
    写内容元数据(page-title / summary / tags / updated)。
  2. 第二步
    用语义组件组织正文,不用手写样式。
  3. 第三步
    跑 npm run check:content 再提交。
  • 立项
    2026-01
    需求与范围确认。
  • 标准化中
    2026-09
    组件样板与撰写规范落地。
  • 推广
    后续
    逐章对齐风格。

统计卡 / 卡片网格 / 特性网格

55章
8大篇
0死链

引文 / 分隔 / 折叠

标识装好只是开始,把技术动作固化为组织能力,才能「建得成、管得住」。

— 阶段三 · 长效
下面是折叠示例
展开看:两列键值表怎么写
材料铝合金
工艺UV 直喷

示例块 example(演示 / 用法)

给读者看一个具体样例时用 .example,区别于 callout 的语义提示。

示例 · 编号铭牌怎么写

点位编号建议采用「楼层-区域-序号」三段式,例如 3F-A-07,并保证与档案系统一致。

代码块(浅色清爽风)

正文代码用标准 <pre><code>,已统一浅底深字;长代码自动横向滚动,不串行、无双层背景。

node scripts/zone-rewrite.mjs   # 双部署 zone 重写
npm run build                   # 生产构建 + Pagefind 索引

通用红线(每条都过校验)

提交前必查
  • 每页有且仅有 1 个 h1(外壳注入,源文件别写)。
  • 两列键值表左列用 <th scope="row">,否则报「无表头」且文字不可见。
  • 图片必须写 alt,缺 alt 直接判缺陷。
  • 跨章链接用站点相对路径,大小写须与文件名一致——构建会把 ASCII 小写化,本地能开、Linux 部署会 404。