CONTRIBUTING.md

贡献指南

欢迎提交 Pull Request！为了保持文档的一致性和可读性，请在提交 PR 时遵循以下要求。

格式要求

1. 中英文间距

• 中文和英文、数字之间需要有空格
• ❌ 错误：Geocaching地理藏宝、Python3.7
• ✅ 正确：Geocaching 地理藏宝、Python 3.7

2. 锚点

• 所有 ## 及以上级别的标题都需要添加锚点（ID）
• 格式：## 标题名称 { #anchor-name }
• 锚点使用小写英文，多个单词用连字符 - 连接
• 例如：## 如何开始 { #how-to-start }

3. 标题结构

• 使用 # 一级标题，## 二级标题，以此类推
• 不要跳级（例如从 ## 直接跳到 ####）
• 避免重复使用一级标题

4. 图片和媒体

• 使用 Markdown 标准语法：![alt](path)
• 可添加宽度和对齐属性：![alt](path){ width="60%" align=right }
• 重要图片使用 <figure> 标签包装：

  <figure markdown="span">
      ![描述](./imgs/example.jpg){ width="60%" }
      <figcaption>图片说明</figcaption>
  </figure>

5. 提示框和可折叠内容

• 提示框：使用 !!! 语法

  !!! info "提示标题"
      提示内容

• 可折叠块：使用 ??? 语法

  ??? note "点击展开"
      可折叠内容

6. 格式化元素

• 加粗：**文本**
• 斜体：*文本*（谨慎使用）
• 代码：`代码`
• 删除线：<del>文本</del>
• 彩色文字：<span style="color:#c75a3b">文本</span>

7. 列表

• 无序列表用 -，有序列表用 1.
• 列表项前后需要空行分隔
• 嵌套列表缩进 2 个空格

内容要求

• 内容需要准确无误，特别是教程和指南类内容
• 新增内容应该与项目主题相关（Geocaching 相关）
• 优先使用中文表述，英文术语可保留但需要解释

提交要求

1. 在提交 PR 前，请在本地运行 mkdocs serve 预览效果
2. 确保没有拼写错误和格式问题
3. PR 标题清晰，描述详细（说明改动内容和原因）
4. 如涉及大的内容调整，建议先开 Issue 讨论

文件组织

• 新增页面放在合适的目录下（如 docs/getting-started/、docs/hiding-a-cache/ 等）
• 在 mkdocs.yml 的 nav 部分添加相应条目
• 相关的图片放在该目录的 imgs/ 文件夹中

感谢

感谢您的贡献！🙏