文档 · 内容维护
编辑文档
用 Markdown 维护设计站文档中心,侧栏与大纲自动生成。
目录约定
文档真源在 site/content/docs/:
- 子文件夹名 = 左侧菜单分组(例如
由此开始/、内容维护/) - 每个
.md文件 = 一篇文档页,路由为/docs/<相对路径>/
文件头部
---
title: "标题"
description: "列表与页首摘要"
order: 10
draft: false
category: "指南"
---
| 字段 | 作用 |
|---|---|
title |
侧栏与页面标题 |
description |
索引卡片与页首导语 |
order |
同组内排序(越小越前) |
draft |
true 时不出现在站点 |
category |
仅平铺在根目录时用作分组名 |
正文与大纲
正文使用二级、三级标题(## / ###)。构建时会提取这些标题生成右侧「本页目录」。
预览
本地开发服务下保存文件后刷新对应 /docs/... 路径。正式发布走站点常规构建流程。