美文网首页笔戈 Web Teamgit studyMac开发
gollum:给wiki插上git的翅膀

gollum:给wiki插上git的翅膀

作者: 天青色等烟雨 | 来源:发表于2015-01-23 15:34 被阅读17780次

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

    Gollum 的截图如下


    GollumGollum

    基本的环境

    在安装之前,我已经安装了了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.

    GemEerrorGemEerror
    这个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!

    原文地址

    相关文章

      网友评论

      • f5789e545aaf:这个Gollum安装完了使用Markdown 不知道为什么不解析表格 是还需要什么配置么 :joy:
      • 之行始于:没有bundler的先安装
        brew install Ruby
        gem install bundler
      • 71b62b0f6399:赞,mark一下,万一有问题再看看楼主的攻略
      • xPW35M:哥们 不写wiki你写啥? 作为it人员,资料那么多,经过evernote 本地doc,最终我还是选择了dokuwiki 才算过得去。
      • Gevin:这个可以收录到我这篇文章里去 :smile:
        http://www.jianshu.com/p/2e35ef496be7

      本文标题:gollum:给wiki插上git的翅膀

      本文链接:https://www.haomeiwen.com/subject/udohxttx.html