文档章节

基于gollum的wiki搭建

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

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

基于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
Option Arguments Description
--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
--bare none Tell 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.
--css none Tell Gollum to inject custom CSS into each page. Uses custom.css from repository root
--js none Tell Gollum to inject custom JS into each page. Uses custom.js from repository root
--emoji none Parse and interpret emoji tags (e.g. :heart:).
--no-edit none Disable the feature of editing pages.
--live-preview none Enable the live preview feature in page editor.
--no-live-preview none Disable 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
--mathjax none Enables MathJax (renders mathematical equations). By default, uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension
--irb none Launch Gollum in "console mode", with a predefined API.
--h1-title none Tell Gollum to use the first <h1> as page title.
--show-all none Tell Gollum to also show files in the file view. By default, only valid pages are shown.
--collapse-tree none Tell 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.
--help none Display the list of options on the command line.
--version none Display 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
4.3K
0
web前后端 技术栈

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

mingle
2015/12/22
272
0
很赞的开源小工具

最近整理了一些在用的,感觉还不错的开源小工具,有的仅适用MacOS,但多数跨平台。原文见很赞的开源小工具 - yongle。 Homebrew Homebrew — The missing package manager for macOS,Mac上非...

米乐乐果
2017/09/24
0
0
PYTHON后端相关技术/工具栈

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

好铁
2016/02/12
82
0
2台linux机器安装gollum,其中一台centos的gollum界面打开或者跳转非常慢

2台linux机器安装gollum,其中一台centos的gollum界面打开或者跳转非常慢,感觉打开页面要10秒左右吧。但是另外一台就非常快,基本上1秒以内。不知道是不是2台机器的os版本或者其他的ruby这些...

youzhoutai
2016/06/15
165
0

没有更多内容

加载失败,请刷新页面

加载更多

mysql免安装

参考:http://blog.csdn.net/qq_28569585/article/details/79072805 [mysqld]#设置mysql密码为空#skip-grant-tables#设置3306端口 port = 3306# 设置mysql的安装目录 basedir=E...

秋默
4分钟前
1
0
立足于SpringCloud.H + Netflix-Ribbon + Hystrix断路器(9)

《SpringCloud.H心法总纲》 继续上一篇,接下来Springcloud配置Netflix-Ribbon集成Hystrix断路器的功能。 1、添加依赖 <!--使用hystrix,测试断路器--><dependency> <groupId>org.spr......

木九天
5分钟前
1
0
Dropbox怎么共享文件?Dropbox共享文件操作

Dropbox网盘是国外的一项云存储服务,这意味着即使您使用的是其他设备,您也可以将文件复制到云中并在以后访问它们,目前支持PC、Android和MAC三大平台,为用户带来最精准的资源传输工作。就...

坚果云
8分钟前
4
0
Vant Weapp 1.0 正式版发布

1.0 来了 2018 年 8 月 11 日,我们发布了 Vant Weapp 的首个版本。16 个月以来,我们收到了 27 位开发者贡献的 1000 多次提交,也处理了 1200 多个 issue,发布了 50 多个版本。Github 的 ...

有赞coder
9分钟前
2
0
VCF文件格式详解

VCF文件全称为Variant Call Format,表示基因组的变异信息,通常为GATK和Samtools软件处理所得到。 VCF文件大致可以分为两个部分: 1、以##开头的头文件信息 ##fileformat=VCFv4.2##FILTER...

悲催的古灵武士
10分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部