前言

为什么要使用 git + markdown 管理文档

公司在不同时期，分别使用过很多不同的方式管理文档，如

• 自建 WikiPedia
• 第三方项目管理工具内置的文档管理
  • Tower
  • TAPD
• 第三方文档平台
  • Notion
  • 语雀

选择使用哪一个平台，很多时候是不可控的，比如平台关停、涨价等。但是每一家都会有自己的私有文档书写及组织方式，并且相互之间不能全兼容导入，这给文档迁移带来了很多麻烦，甚至也有很多文档在迁移过程中丢失。

因此，前端组文档，统一使用 markdown 文件保存原始版本。各个平台只是作为展示界面，此仓库作为最基础的数据源。

Markdown 语法约定

为了避免导入到各平台的渲染差异，在书写时，必须 使用 基础、普适 的 markdown 语法，避免使用私有标记，如

• VitePress 的 :::
• Github Flavored Markdown 的 [ ]

自有访问地址

本仓库托管在 Cloudflare Pages 上，可以直接通过 https://f2e.seemusic.xyz 访问 main 分支的版本。

同理，只要内容推送到 main 分支，会自动触发构建更新。