gollum:給wiki插上git的翅膀

gollum 是github的使用的一個基于markdown的 wiki系統(tǒng)的構(gòu)造工具刹帕,簡單實用喻旷。gollum直接和git集成不需要數(shù)據(jù)庫钝腺,你可以選擇在Web頁面撰寫文檔啦辐,也可以用你喜歡的markdown工具編輯文檔在命令行進行提交。 “markdown+git = wiki” 這對程序員來講絕對是最優(yōu)(zhe)雅(teng)的方式慷暂。

Gollum 的截圖如下


Gollum
Gollum

基本的環(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
GemEerror

這個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,安裝成功會如下圖所示:



安裝成功后嘗試著在終端輸入下面的命令血久,如果能夠正常顯示版本號則說明安裝成功.我的版本為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隅忿。如下圖所示:

Clone Wiki到本地

git clone相應(yīng)wiki的git地址,請格外注意邦尊,地址是在你 Repositories的git地址之前加上wiki:

Repositories地址

git@github.com:nicesu/blog-theme.git

wiki地址

git@github.com:nicesu/blog-theme.wiki.git

使用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

然后我們就可以在瀏覽器里進行操作:


在這里我們可以創(chuàng)建新的wiki,也可以修改我們過去創(chuàng)建好的wiki杖刷,而且支持的格式非常多:


編輯完成后励饵,使用git命令進行提交

cd ~/wiki
git add .
git commit -am"嘿嘿,我就想試試可以提交嗎“
git push

有了這個滑燃,突然間很想寫wiki!

原文地址

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末役听,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子表窘,更是在濱河造成了極大的恐慌典予,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,204評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件乐严,死亡現(xiàn)場離奇詭異瘤袖,居然都是意外死亡,警方通過查閱死者的電腦和手機昂验,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,091評論 3 395
  • 文/潘曉璐 我一進店門捂敌,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人既琴,你說我怎么就攤上這事占婉。” “怎么了呛梆?”我有些...
    開封第一講書人閱讀 164,548評論 0 354
  • 文/不壞的土叔 我叫張陵锐涯,是天一觀的道長磕诊。 經(jīng)常有香客問我填物,道長纹腌,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,657評論 1 293
  • 正文 為了忘掉前任滞磺,我火速辦了婚禮升薯,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘击困。我一直安慰自己涎劈,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,689評論 6 392
  • 文/花漫 我一把揭開白布阅茶。 她就那樣靜靜地躺著蛛枚,像睡著了一般。 火紅的嫁衣襯著肌膚如雪脸哀。 梳的紋絲不亂的頭發(fā)上蹦浦,一...
    開封第一講書人閱讀 51,554評論 1 305
  • 那天,我揣著相機與錄音撞蜂,去河邊找鬼盲镶。 笑死,一個胖子當(dāng)著我的面吹牛蝌诡,可吹牛的內(nèi)容都是我干的溉贿。 我是一名探鬼主播,決...
    沈念sama閱讀 40,302評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼浦旱,長吁一口氣:“原來是場噩夢啊……” “哼宇色!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起颁湖,我...
    開封第一講書人閱讀 39,216評論 0 276
  • 序言:老撾萬榮一對情侶失蹤代兵,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后爷狈,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體箩艺,經(jīng)...
    沈念sama閱讀 45,661評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,851評論 3 336
  • 正文 我和宋清朗相戀三年环壤,在試婚紗的時候發(fā)現(xiàn)自己被綠了一死。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,977評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡羡微,死狀恐怖谷饿,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情妈倔,我是刑警寧澤博投,帶...
    沈念sama閱讀 35,697評論 5 347
  • 正文 年R本政府宣布,位于F島的核電站盯蝴,受9級特大地震影響毅哗,放射性物質(zhì)發(fā)生泄漏听怕。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,306評論 3 330
  • 文/蒙蒙 一虑绵、第九天 我趴在偏房一處隱蔽的房頂上張望尿瞭。 院中可真熱鬧,春花似錦翅睛、人聲如沸声搁。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,898評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽疏旨。三九已至,卻和暖如春扎酷,著一層夾襖步出監(jiān)牢的瞬間充石,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,019評論 1 270
  • 我被黑心中介騙來泰國打工霞玄, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留骤铃,地道東北人。 一個月前我還...
    沈念sama閱讀 48,138評論 3 370
  • 正文 我出身青樓坷剧,卻偏偏與公主長得像惰爬,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子惫企,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,927評論 2 355

推薦閱讀更多精彩內(nèi)容

  • WebSocket-Swift Starscream的使用 WebSocket 是 HTML5 一種新的協(xié)議撕瞧。它實...
    香橙柚子閱讀 23,864評論 8 183
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)狞尔,斷路器丛版,智...
    卡卡羅2017閱讀 134,657評論 18 139
  • 我開始守口如瓶 你的壓抑排斥自我 不與我走一起 越過飛向山巒 是沒有家眷毫不在意 自私的聲音搖晃在腦海里 他不與任...
    胤女閱讀 177評論 0 0
  • 都說日更日更研儒,日更可是為了寫而寫豫缨?不是最好,要不寫的樂趣何在端朵? 一片文章無外乎作者的和讀者好芭,而一篇好的文章那就是讀...
    天然之樂閱讀 284評論 3 2
  • 我認識了新的室友,新的朋友冲呢,聽了新歌舍败,聽了新的演講,開始了新的人生,現(xiàn)在給自己一句話邻薯,不要迎合別人裙戏,做你自己...
    宸曦兒閱讀 228評論 0 0