欢迎查阅本站的文档风格指南!以下是编写和维护文档时需遵循的核心规范:

📌 基本原则

  • 一致性:所有文档使用相同的术语(如:API需全大写)
  • 简洁性:避免冗长描述,使用短句和分点说明
  • 可读性:段落间距保持在2个空行,代码块用```语法包裹
  • 多语言支持:英文文档路径如 /en/style_guide,中文路径如 /zh/style_guide

🧾 格式规范

项目 要求
标题 使用 # 表示主标题,## 表示子标题
代码 每段代码需标注语言(如:```python)
链接 内部链接以 / 开头,外部链接使用完整URL

📈 示例参考

## 标题示例
- 正确:`### 核心功能说明` ✅
- 错误:`## 核心功能说明` ❌

## 链接示例
- 内部:[贡献指南](/docs/contributing) 🌐
- 外部:[MDN Web Docs](https://developer.mozilla.org/)

📷 图片展示

文档风格指南

📚 扩展阅读

请根据实际需求调整格式,并参考上述示例保持统一风格!