协作指南

本知识库托管在 GitHub 上,任何人都可以通过 Pull Request 参与编辑。

在线编辑(最简单)

  1. 访问本仓库的 GitHub 页面
  2. 找到想修改的笔记,点击 ✏️ 编辑按钮
  3. 在线修改内容
  4. 提交 Pull Request
  5. 等待 Review 和 Merge

本地编辑(推荐)

# Fork 本仓库
git clone https://github.com/你的用户名/本仓库名.git
 
# 用 Obsidian 打开 content/ 目录
# 编辑笔记...
 
# 提交并推送
git add .
git commit -m "更新某笔记"
git push
 
# 在 GitHub 上创建 Pull Request

编辑规范

  • 遵循现有笔记的风格
  • 文件名用英文 + 短横线
  • 中文标题写在 frontmatter title 字段
  • 善用 双向链接 连接相关知识