使用 git 简化 github wiki 的编写 - mindpin/docs GitHub Wiki
github wiki 不一定需要在线编写。
尤其是,当需要一次写大量内容时,网页上的编辑环境是容易束缚人的思路的。
本地撰写会更舒适。
采用简单的步骤就可以做到在本地撰写 github wiki.
-
第一步,将指定项目的 wiki 作为代码 clone 到本地。
打开任何项目的 wiki 页,例如 https://github.com/mindpin/docs/wiki看右下角:
复制这个地址,然后在本地 clone
git clone https://github.com/mindpin/docs.wiki.git
clone 之后,本地就有名为 docs.wiki 的目录,里面放了一堆 .md 文件
-
第二步,本地编辑
用任何编辑器就可以自由编辑了。语法就是 markdown,和在线编辑并没有区别。
当文件名(词条名)有一些特殊字符时,会有特定的命名规则,参考这里 -
第三步,提交回 github
编辑完所需要编辑的文件之后,再在本地使用 git 进行
commit
然后push
回去就可以了dd。