gollum 是github的使用的一個基于markdown的 wiki系統(tǒng)的構(gòu)造工具刹帕,簡單實用喻旷。gollum直接和git集成不需要數(shù)據(jù)庫钝腺,你可以選擇在Web頁面撰寫文檔啦辐,也可以用你喜歡的markdown工具編輯文檔在命令行進行提交。 “markdown+git = wiki” 這對程序員來講絕對是最優(yōu)(zhe)雅(teng)的方式慷暂。
Gollum 的截圖如下
![Gollum](http://ww2.sinaimg.cn/large/005yyi5Jjw1eojexe11l1j31g20w20v1.jpg)
基本的環(huán)境
在安裝之前聘殖,我已經(jīng)安裝了了mac 下的包管理工具 homebrew 及 ruby 運行環(huán)境。我當(dāng)前的工作環(huán)境如下:
- MacBook Pro 10.10.1
- Homebrew 0.9.5
- ruby 2.0.0p481 (2014-05-08 revision 45883) [universal.x86_64-darwin14]
安裝 gollum
這里我使用官方推薦的安裝方式:
The best way to install Gollum is with RubyGems:
$ sudo gem install gollum
安裝過程遇到了如下問題:Gem::Installer::ExtensionBuildError: ERROR: Failed to build gem native extension.
![GemEerror](http://ww1.sinaimg.cn/large/005yyi5Jjw1eojftrn55lj31kw0hddsd.jpg)
這個bug困擾了我大半天行瑞,最好無奈我只能找來梯子外出詢問奸腺,最后找到的解決的辦法,辦法就是在執(zhí)行g(shù)em安裝命令之前在命令行執(zhí)行以下代碼:
$ bundle config --local build.charlock_holmes --with-ldflags='-L.-Wl,-O1 -Wl,--as-needed -rdynamic -Wl,-export-dynamic -Wl,--no-undefined -lz -licuuc'
執(zhí)行完成后,再繼續(xù)安裝gollum,安裝成功會如下圖所示:
![](http://ww2.sinaimg.cn/large/005yyi5Jjw1eojfzmahtij31e00ps7io.jpg)
安裝成功后嘗試著在終端輸入下面的命令血久,如果能夠正常顯示版本號則說明安裝成功.我的版本為3.1.1
$ gollum --v
gollum 3.1.1
ok,現(xiàn)在我們就可以愉快的開始折騰gollum
創(chuàng)建自己的wiki系統(tǒng)
建立一個名字為”myWiki”的目錄使用git進行管理突照。進入到wiki目錄,在wiki目錄下啟動gollum氧吐。
mkdir myWiki
cd myWiki
git init
gollum
這是命令行會顯示如下:
[2015-01-23 13:43:12] INFO WEBrick 1.3.1
[2015-01-23 13:43:12] INFO ruby 2.0.0 (2014-05-08) [universal.x86_64-darwin14]
== Sinatra/1.4.5 has taken the stage on 4567 for development with backup from WEBrick
[2015-01-23 13:43:12] INFO WEBrick::HTTPServer#start: pid=95946 port=4567
localhost - - [23/Jan/2015:13:43:14 CST] "GET / HTTP/1.1" 302 0
- -> /
打開你最愛的瀏覽器讹蘑,輸入localhost:4567末盔,奇跡就出現(xiàn)了!
github的wiki在本地進行編輯
開通Wiki
登陸Github座慰,找到你所開通的Github項目的Settings欄目陨舱,開通Wikis,如果只希望別人可讀不可寫版仔,勾選:Restrict edits to Collaborators only隅忿。如下圖所示:
![](http://www.yangzhiping.com/images/tech/gollum/github_wiki.png)
Clone Wiki到本地
git clone相應(yīng)wiki的git地址,請格外注意邦尊,地址是在你 Repositories的git地址之前加上wiki:
Repositories地址
git@github.com:nicesu/blog-theme.git
wiki地址
使用git clone命令進行clone到本地的blogWiki目錄下
$ git clone it@github.com:nicesu/blog-theme.wiki.git blogWiki
執(zhí)行這個操作我遇到了倆個該死的問題:
Permission denied (publickey).
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
fatal: remote error: access denied or repository not exported
第一個問題是因為我的github沒有添加本地的SSH keys,解決辦法是在本地生成密鑰對背桐,然后添加到github的賬號中。
第二個問題.....是因為我忘記要先在Repositories中創(chuàng)建一個wiki的頁面蝉揍!
花了一天的時候來挖坑和填坑链峭,希望對大家有點幫助!
用golllum來編輯github的wiki
通過以上的過程又沾,我們已經(jīng)clone了Repositories的wiki到我們本地弊仪,進入它的目錄,執(zhí)行:
$ gollum
然后我們就可以在瀏覽器里進行操作:
![](http://www.yangzhiping.com/images/tech/gollum/gollum.png)
在這里我們可以創(chuàng)建新的wiki,也可以修改我們過去創(chuàng)建好的wiki杖刷,而且支持的格式非常多:
![](http://ww2.sinaimg.cn/large/005yyi5Jjw1eojhaxfc75j31gm0xqgoz.jpg)
編輯完成后励饵,使用git命令進行提交
cd ~/wiki
git add .
git commit -am"嘿嘿,我就想試試可以提交嗎“
git push
有了這個滑燃,突然間很想寫wiki!