gollum:给wiki插上git的翅膀

gollum 是github的使用的一个基于markdown的 wiki系统的构造工具,简单实用。gollum直接和git集成不需要数据库,你可以选择在Web页面撰写文档,也可以用你喜欢的markdown工具编辑文档在命令行进行提交。 “markdown+git = wiki” 这对程序员来讲绝对是最优(zhe)雅(teng)的方式。

Gollum 的截图如下


Gollum
Gollum

基本的环境

在安装之前,我已经安装了了mac 下的包管理工具 homebrew 及 ruby 运行环境。我当前的工作环境如下:

  • 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困扰了我大半天,最好无奈我只能找来梯子外出询问,最后找到的解决的办法,办法就是在执行gem安装命令之前在命令行执行以下代码:

$ bundle config --local build.charlock_holmes --with-ldflags='-L.-Wl,-O1 -Wl,--as-needed -rdynamic -Wl,-export-dynamic -Wl,--no-undefined -lz -licuuc'

执行完成后,再继续安装gollum,安装成功会如下图所示:



安装成功后尝试着在终端输入下面的命令,如果能够正常显示版本号则说明安装成功.我的版本为3.1.1

$ gollum --v
  gollum 3.1.1

ok,现在我们就可以愉快的开始折腾gollum

创建自己的wiki系统

建立一个名字为”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,奇迹就出现了!

github的wiki在本地进行编辑

开通Wiki

登陆Github,找到你所开通的Github项目的Settings栏目,开通Wikis,如果只希望别人可读不可写,勾选:Restrict edits to Collaborators only。如下图所示:

Clone Wiki到本地

git clone相应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

执行这个操作我遇到了俩个该死的问题:

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中创建一个wiki的页面!

花了一天的时候来挖坑和填坑,希望对大家有点帮助!

用golllum来编辑github的wiki

通过以上的过程,我们已经clone了Repositories的wiki到我们本地,进入它的目录,执行:

$ gollum

然后我们就可以在浏览器里进行操作:


在这里我们可以创建新的wiki,也可以修改我们过去创建好的wiki,而且支持的格式非常多:


编辑完成后,使用git命令进行提交

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

有了这个,突然间很想写wiki!

原文地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345

推荐阅读更多精彩内容

  • WebSocket-Swift Starscream的使用 WebSocket 是 HTML5 一种新的协议。它实...
    香橙柚子阅读 23,724评论 8 183
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 我开始守口如瓶 你的压抑排斥自我 不与我走一起 越过飞向山峦 是没有家眷毫不在意 自私的声音摇晃在脑海里 他不与任...
    胤女阅读 175评论 0 0
  • 都说日更日更,日更可是为了写而写?不是最好,要不写的乐趣何在? 一片文章无外乎作者的和读者,而一篇好的文章那就是读...
    天然之乐阅读 270评论 3 2
  • 我认识了新的室友,新的朋友,听了新歌,听了新的演讲,开始了新的人生,现在给自己一句话,不要迎合别人,做你自己...
    宸曦儿阅读 226评论 0 0