开源wiki系统:gollum | KaiQ.Gu|KerwinKoo Blog
安装及设置
按照github官网中的方法安装即可,安装过程中的个人经验做下总结。
注意问题
在安装之后,如果将现有markdown文件放入wiki目录下,再启动gollum是不会显示新文件的,因为该文件没有加入git。
官网的解释原文是:
Navigate to your git repository (wiki) via the command line.即必须有git。
格式优化
单启动gollum只会启动wiki的最基本服务,通过以下办法可以增加新的插件。
侧边栏显示该文件的目录
在wiki的git主目录下新建文件 _Sidebar.md,将目录显示宏写入文件内保存:
1 | {[_TOC_]] #将第一个{改为[ |
由于此文章本身是在wiki中编写,因此不能写入此宏代码,需要将左边第一个"{"符号改为"["。
重启gollum即可
增加主页全文件目录
新建Home.md后,在此文件中写入以下(不要复制注释):
1 | {<GlobalTOC()>> #将左边第一个{改为< |
同理,需要将左边第一个{改为<
创建文件目录
在点击new创建新文件后,在文件名中增加/来创建新的目录。如创建目录tec下的文件test.md,则在文件名中输入:
tec/test之后会自动创建tec下的文件test.md
更新和发布
将wiki中的资源更新到github中可以保存文件。首先找一个用于存储wiki的github项目,我是存在kerwinkoo blog项目中,即私人博客。
发布过程:
1 | git add . git commit -m "update record" git push |
到第二步完成,再启动本地的gollum后就已经可以看到更新后的结果了,第三步是为了将文件上传到github中。
另外第三步需要输入github账号,因为wiki是谁都可以修改的,因此git clone时只能获取其https的地址,无法获取git的地址。
已知BUG
- 目前不支持标签系统,不支持关键字排行系统;
- 搜索功能无法做到空格来控制多关键字搜索;
- 不支持中文文件名。创建文件名时,会自动将汉子转为拼音,将符号转为对应的英文,如
&转为and。