灶台在前，菜单在册，做菜不怕~

曾疲于文档存放的用户，或许 wiki.git 会是个不错的挑选,话不多说，启动！

前置条件

先来点前置条件！

  • 有一个 Github OR GitLab 项目
    • 公司私有化的 GitLab 版本最好 >= 14.9
    • Github 项目有必要付费！
  • 一点点 MarkDown 知识
  • 本文运用 GitLab 作为内容源头，如有出入，请自行调整

Git Clone 冲！

当确定好各自环境后，启动！

# 下载相关
git clone XXX/[projectName].wiki.git

clone 下来一个 [projectName].wiki 的文件目录，里面大概率是空的，主张按以下目录新建一些文件夹与文件

|-- [projectNme].wiki/
|   |-- assets                    // 静态文件存储，一般为图片资源
|   |-- _sidebar.md               // 侧栏规矩存储
|   |-- home.md                   // 默许首页

一些实践

  1. _sidebar.md 是 wiki 页面的大局侧边栏。假如没有这个文件，Gitlab 会有一套默许的侧边栏规矩
  2. 侧栏链接规矩需要运用全路径

关于 wiki.git 的二三事
3. Gitlab 左面菜单点击 wiki 菜单项指向的便是 home.md

一些约定

  1. home.md 文件不允许随意更改
  2. 尽可能运用 markdown 作为，文档标准言语
  3. 尽可能少运用 gitLab 界面编写 wiki

小结

本文大略提供了一种开发文档的管理方式，基本上是以单个项目维度作为保护，实践与约定均是个人定见，仅供参考

感谢阅览