文档中心 · 指南

内容字段说明

每篇文档头部的字段含义与填写约定。

通用字段

每篇 Markdown 文档以字段头(frontmatter)开始。title 是页面标题,description 用于列表卡片与搜索摘要,draft 默认不公开,必须明确写 draft: false 才会进入正式网站。

帮助文档字段

帮助文档额外使用一个字段。order 是数字,决定目录中的先后顺序;分组由所在子文件夹决定,不在子文件夹时可用 category 字段兑底,两者都没有则归入默认的「指南」组。

文件名与分组即网址

文件名与所在文件夹决定网址,例如 内容维护/content-fields.md 对应 /help/内容维护/content-fields/。标题可以随时改;发布后改文件名或挪动分组会改变网址,需要额外配置重定向。