文档章节

基于gollum的wiki搭建

a
 alex
发布于 2016/07/12 19:04
字数 923
阅读 672
收藏 2

基于gollum的wiki搭建

gollum是个啥

gollum是一个基于git的,解析markdown文件的wiki系统;gollum项目托管在github上:gollumhttps://github.com/gollum/gollum),项目的wiki地址:https://github.com/gollum/gollum/wiki github的wiki据说也是基于gollum搭建的;没确认;

搭建

gollum是基于ruby编写的;所以在安装gollum之前,需要先安装ruby环境;

  1. 安装依赖包 gollum依赖的包还是蛮多的,包括了ruby ,ruby-devel ,git 等等;看自己服务器的情况增加依赖包;
yum -y install ruby ruby-devel rubygems make gcc libxml2-devel libxslt-devel git libicu-devel

ruby版本建议在2.0+; git最好用最新版吧; 2. 安装gollum

gem install gollum

中文目录/文件名问题解决 注意:建议安装 Rugged;这个是gollum所需要的git adapter ;默认的git adapter 是grit;但实际在用这个适配器的时候,会发现这个适配器不支持中文文件名、目录的问题;使用 rugged是没有问题的;

  1. 安装Rugged
gem install gollum-rugged_adapter
  1. 在启动的时候,加上参数:
--adapter rugged

启动

gollum是与git配合使用的,所以gollum的命令也要在git目录下才能启动;

  • 命令如下
gollum --port 4567 --adapter rugged --no-edit --base-path /wiki
OptionArgumentsDescription
--host[HOST]Specify the hostname or IP address to listen on. Default: 0.0.0.0.1
--port[PORT]Specify the port to bind Gollum with. Default: 4567.
--config[FILE]Specify path to Gollum's configuration file.
--ref[REF]Specify the git branch to serve. Default: master.
--adapter[ADAPTER]Launch Gollum using a specific git adapter. Default: grit
--barenoneTell Gollum that the git repository should be treated as bare. This is only necessary when using the default grit adapter.
--base-path[PATH]Specify the leading portion of all Gollum URLs (path info). Setting this to /wiki will make the wiki accessible under http://localhost:4567/wiki/. Default: /.
--page-file-dir[PATH]Specify the subdirectory for all pages. If set, Gollum will only serve pages from this directory and its subdirectories. Default: repository root.
--cssnoneTell Gollum to inject custom CSS into each page. Uses custom.css from repository root
--jsnoneTell Gollum to inject custom JS into each page. Uses custom.js from repository root
--emojinoneParse and interpret emoji tags (e.g. :heart:).
--no-editnoneDisable the feature of editing pages.
--live-previewnoneEnable the live preview feature in page editor.
--no-live-previewnoneDisable the live preview feature in page editor.
--allow-uploads[MODE]Enable file uploads. If set to dir, Gollum will store all uploads in the /uploads/ directory in repository root. If set to page, Gollum will store each upload at the currently edited
--mathjaxnoneEnables MathJax (renders mathematical equations). By default, uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension
--irbnoneLaunch Gollum in "console mode", with a predefined API.
--h1-titlenoneTell Gollum to use the first <h1> as page title.
--show-allnoneTell Gollum to also show files in the file view. By default, only valid pages are shown.
--collapse-treenoneTell Gollum to collapse the file tree, when the file view is opened. By default, the tree is expanded.
--user-icons[MODE]Tell Gollum to use specific user icons for history view. Can be set to gravatar, identicon or none. Default: none.
--mathjax-config[FILE]Specify path to a custom MathJax configuration. If not specified, uses the mathjax.config.js file from repository root.
--template-dir[PATH]Specify custom mustache template directory.
--helpnoneDisplay the list of options on the command line.
--versionnoneDisplay the current version of Gollum.
  • 参数备注
  1. The 0.0.0.0 IP address allows remote access. Should you wish for Gollum to turn into a personal Wiki, use 127.0.0.1.
  2. Before using --adapter, you should probably read this first.
  3. When --css or --js is used, respective files must be committed to your git repository or you will get a 302 redirect to the create a page.
  4. Files can be uploaded simply by dragging and dropping them onto the editor's text area (this is, however exclusive to the default editor, not the live preview editor).
  5. Read the relevant Security note before using these.
  • 配置文件 When --config option is used, certain inner parts of Gollum can be customized. This is used throughout our wiki for certain user-level alterations, among which customizing supported markups will probably stand out.

使用说明

  1. 配合 gitlab webhook + jenkins(或者其它CI工具) 配合使用,在文件有push动作的时候,自动更新md文件,达到wiki的自动发布;

© 著作权归作者所有

共有 人打赏支持
a
粉丝 9
博文 14
码字总数 10631
作品 0
福州
高级程序员
私信 提问
Git 上的 wiki 构造工具--Gollum

Gollum 是 Git 上面 wiki 系统的构造工具,简单实用。Gollum wikis 是简单的 Git 库,遵循特定的格式。Gollum 上面允许使用多种格式,有多种编辑的方式。 你可以在本地编辑你的 wiki : 用你最...

叶秀兰
2013/12/18
3.9K
0
web前后端 技术栈

1、Jenkins 是一个开源软件项目,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。 2、Vagrant 是一个基于Ruby的工具,用于创建和部署虚拟化开发环境。它 使用Oracle的开源Virtu...

mingle
2015/12/22
169
0
GitLab 5.0 发布,不再使用 Gitolite

GitLab 5.0 发布了,该版本最大的变化就是废弃了 Gitolite。 5.0 最值得关注的三个改进是: 使用 GitLab-shell 替换 Gitolite 只需要一个 git 用户来运行 GitLab ,之前需要 gitlab 和 git ...

oschina
2013/03/23
13.4K
12
GitLab 8.3.0 rc1 发布,代码托管平台

GitLab 8.3.0 rc1 发布,8.3.0 (unreleased)更新如下: - Expand character set of usernames created by Omniauth (Corey Hinshaw) - Add button to automatically merge a merge request ......

oschina
2015/12/16
636
2
PYTHON后端相关技术/工具栈

编辑器 最常见: vim / SublimeText2 / PyCharm Vim有兴趣可以看看 k-vim 适合Python/Golang开发 本地环境 pip/easy_install 包管理 viertualenv + virtualenvwrapper 库/版本管理, 环境隔离 ...

好铁
2016/02/12
41
0

没有更多内容

加载失败,请刷新页面

加载更多

Ubuntu常用操作

查看端口号 netstat -anp |grep 端口号 查看已使用端口情况 netstat -nultp(此处不用加端口号) netstat -anp |grep 82查看82端口的使用情况 查找被占用的端口: netstat -tln netstat -tl...

hc321
昨天
0
0
网站cdn的静态资源突然访问变的缓慢,问题排查流程

1.首先我查看了一下是否自己的网络问题,通过对比其他资源的访问速度和下载速度,确认不是 2.通过ping 和 tracert 判断cdn域名能否正常访问,(最后回想感觉这一步可以省略,因为每次最终能访...

小海bug
昨天
0
0
Mybatis 学习笔记四 MyBatis-Plus插件

Mybatis 学习笔记四 MyBatis-Plus插件 maven依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus</artifactId> <ve......

晨猫
昨天
2
0
小白带你认识netty(二)之netty服务端启动(下)

承接上一篇小白带你认识netty(二)之netty服务端启动(上),还剩下两步骤:3、注册Selector:将Channel注册到Selector上 和 4、端口的绑定:服务端端口的监听。 3、注册Selector:将Chann...

天空小小
昨天
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部