Markdown 写作规范
为保证全站风格统一,撰写文档请遵循以下规范。所有规则与本站现有页面(如首页、关于本站)保持一致。
标题层级
- 每页只有一个
#(一级标题),即页面主题 - 章节用
##,小节用###,不要跳级(#后直接用###) - 标题文字简短明确,避免"一些说明"这类模糊表述
# 页面主题
## 第一章节
### 小节
段落与列表
- 段落之间空一行;不要用空格缩进段首
- 并列内容用无序列表
-;有步骤先后关系用有序列表1. 2. 3. - 列表项保持在两行以内,过长内容拆成小节
表格
表格用于结构化对照信息(如功能说明、错误码),表头加粗由渲染器自动处理:
| 功能 | 说明 |
|---|---|
| 全站搜索 | MkDocs 内置搜索 |
| 功能 | 说明 |
|---|---|
| 全站搜索 | MkDocs 内置搜索 |
图片
- 图片统一放在
docs/img/目录,文件名用英文小写加连字符 - 用相对路径引用,并写清替代文字:

链接
- 站内链接用相对路径:
[关于本站](../about.md) - 站外链接写完整 URL,必要处加
target说明 - 链接文字要能说明去向,避免"点这里"
代码块
命令、配置、代码一律用代码块并标注语言:
```bash
mkdocs serve
```
提醒与注意
重要提示用 Material 的 admonition 语法:
!!! note "提示"
这里是一段提示内容
!!! warning "注意"
请勿删除 docs/CNAME 文件
!!! note "提示" 这里是一段提示内容
命名与用词
- 社区全称统一写 Everyone Create Community(每个人创作社区),不要使用旧称或自造缩写
- 文档名用英文小写加连字符(如
getting-started.md),页面内首行标题可用中文 - 中英文之间加一个空格,如「使用 MkDocs 构建」
写完之后,请按 提交与上线流程 提交你的改动。