【9.12 - 9.14】项目 wiki_docs 完善

9.12 一整天都在宿舍,按照 这篇文章1 所说,利用 GitHub 仓库本身来建立一个 Wiki 库。所谓 Wiki 库就是一个能够存储具有复用价值的知识的仓库,它需要具备三个特点:条理清晰、易于查找、访问方便。

条理清晰

知道自己需要的知识在哪些地方是非常重要的。在日后查找时,一目了然。

易于查找

这点和第一个有些重复,不过侧重点不同。这里的“易”指的是,文档的顺序编排上是值得考量的。不同主题的放在不同文件夹,相同主题的也要遵循一定的规律存储。而且,一个好的目录能够成就一个好的 Wiki 知识库。目录的重要性不言而喻,它是以上两点的主要表现对象。有了它,条理清晰没问题,易于查找也是肯定的。

访问方便

这一点目前对我来说不成问题,以后也不会成为难题。因为 GitHub 在国内的访问速度不是很理想,如果不能科学上网,使用 GitHub 如食鸡肋。


在前两天,我把时间都花在这上面,在这一过程中,我还解决了困惑了我很久的相对路径问题(以我的 GitHub Wiki 库为例):

docs/
    git/
        Basis.md
README.md

如上所示,docs 文件夹下有 Git 文件夹,Git 文件夹下有 Basis.md 文档。README.mddocs 文件夹在同一级。

我想做什么,在 Basis.md 中添加如下内容:

[Parent](/README.md)

希望达到 能够直接跳转到 README.md的目的。

这一想法在 repository 中是可行的,但是在 Github Pages2 中不可行。为什么?因为当我使用 /README.md 进行跳转时,它返回给我的是根路径:https://gaotianhe.github.io/README.md,但是我想要的是 https://gaotianhe.github.io/wiki_docs。所以,这种 /README.md 行不通。下面我又试了诸如 ../README.md.../README.md。前者只能跳到与 git 文件夹同级,后者则不能跳转。那么,这个问题就无法解决了吗?不是的。

我等了很长时间【从我初次遇到这一问题,到9.13解决这个问题】,我终于解决了这个问题,所以,上周日我很开心。

我发现的解决方案:

[Home](../../README.md) • [Parent](../topics.md)

前者能直接回到与 docs 文件夹同级的 README.md,后者则能够帮助我回到与 git 文件夹同级的一个文件。你可以访问 这里3 体验。

参考资料:


  1. https://www.bit-101.com/blog/2020/09/git-based-wiki/ ↩︎

  2. https://pages.github.com/ ↩︎

  3. https://gaotianhe.github.io/wiki_docs/ ↩︎

打开微信扫一扫或者输入“代码者”即可订阅博客
comments powered by Disqus