分享

在Github上搭建自己的wiki介绍

 nikybook 2014-05-14
之前考虑建一个wiki来进行个人知识管理,找来找去,觉得在Github上搭建wiki是一个好的方式。

如何开始,可以看一下:基于Git的维基管理:gollum

其中介绍了gollum,gollum是Github上用到的wiki引擎,使用它可以在本地上搭建一个类似的github wiki的网站,而且你在本地上记录的东西,可以通过git直接同步到Github上。这样子就很方便了,但是在Winodws下无法使用gollum。

本地无法使用gollum,你也可以选择在线编辑wiki页面或是在本地上先写md文档,然后push上去。但是用起来还是会有些单调,那么你可以通过下面的方法添加Sidebar、Header和Footer:

翻译自:ADDING A TABLE OF CONTENTS TO YOUR GITHUB WIKI

你不仅可以给github wiki pages添加sidebar,你也可以定制header和footer。Github wiki pages是通过他们自己开源的git驱动的wiki引擎gollum实现的。

Sidebar Files

Sidebar Files可以给你的wiki pages添加一个侧栏。它们遵循_Siderbar.ext的命名规则,其中.ext是你的wiki格式。Sidebar files会影响同一个目录下的所以pages,以及子目录下没有sidebar files的pages。

如何添加一个Sidebar

  1. 通过git,然后Checkout你的wiki。找到你的wiki页面,点击Git Access.
  2. 将Github上的wiki内容pulled down到本地,创建一个新的文件,命名为_Sidebar.md。
  3. 在这个新创建的_Sidebar.md文件,你可以添加适当的 [[link]]标记内容。
  4. 添加新的文件git add _Sidebar.md,然后提交git commit _Sidebar.md -m "Adding new sidebar.",最后push到github上git push origin master。

Header Files

可以添加简单的header内容给所有的wiki pages。根据 _Header.ext的命名规则。

如何添加Header

  1. 通过git,然后Checkout你的wiki。找到你的wiki页面,点击Git Access.
  2. 将Github上的wiki内容pulled down到本地,创建一个新的文件,命名为_Header.md。
  3. 在_Header.md中添加适当的内容。
  4. 同之前一样

Footer Files

同之前,根据_Footer.ext的命令规则。

如何添加Footer

同之前,创建一个_Footer.md文件,添加适当的内容。

辅助阅读

仔细的看一下gollum的配置选项,设置。


最后可以看一下我在github上的wiki

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多