最佳实践

写作指南

标题规范

• 每页只使用一个 # 一级标题
• 二级标题 ## 用于主要章节
• 三级标题 ### 用于小节
• 不超过四级标题

中英文混排

• 中文和英文之间加一个空格
• 中文和数字之间加一个空格
• 英文和数字之间不需要空格

示例：

这是正确的中文 英文 mixed 写作 123 示例。

代码规范

为代码块指定语言标识，以获得正确的语法高亮：

```python
def greet(name):
    return f"你好，{name}！"
```

链接规范

• 站内链接使用相对路径
• 外部链接使用完整 URL
• 图片路径使用相对路径

文档组织

docs/
├── index.md            # 首页 - 简洁介绍
├── guide/              # 指南 - 教程和概念
├── reference/          # 参考 - 详细的 API 文档
└── about/              # 关于 - 项目信息

原则

1. 单一职责：每页只讲一个主题
2. 由浅入深：指南在前，参考在后
3. 可维护：避免重复内容，善用链接
4. 一致性：保持格式和用语统一