侧边栏壁纸
博主头像
Z同学博主等级

工作磨平激情前,坚持技术的热忱。 欢迎光临Z同学的技术小站。 分享最新的互联网知识。

  • 累计撰写 290 篇文章
  • 累计创建 57 个标签
  • 累计收到 98 条评论
Git

Windows 下 Gollum 安装与使用

Z同学
2021-09-29 / 2 评论 / 2 点赞 / 1,290 阅读 / 3,287 字
温馨提示:
本文最后更新于 2021-11-18,若内容或图片失效,请留言反馈。部分素材来自网络,若不小心影响到您的利益,请联系我们删除。

需求

能够在windows 平台下。对gitlab项目的wiki 进行编辑。

我们都知道针对wiki的编辑,git有一个推荐软件:gollum 。

但是它没有一个安装包,也就是没有exe文件版本。

那么我们在windows平台下该如何安装gollum呢?

1.搭建环境

GitHub :gollum 我们通过它的介绍,可以知道gollum 是基于Ruby开发的一个软件。

那么,我们需要解决的就是如何在windows 环境下执行ruby软件。

也就是一个ruby的解释器。让我们可以直接运行ruby程序

所以,需要先下载 一个叫做JRuby 的软件。官网:JRuby.org

下载windows 版本的安装包。执行安装完毕后。

(PS:安装过程中会提示,默认将path 添加到电脑环境变量之中。)
全程下一步,安装完毕后,通过cmd 命令。

打开命令提示符输入界面。输入: jruby -v

效果:

C:\Users\Zinyan>jruby -v

如何安装成功了。就会打印类似下面的提示, 你安装的jruby的版本号信息。

jruby 9.3.0.0 (2.6.8) 2021-09-17 85c20e780f Java HotSpot(TM) 64-Bit Server VM 25.291-b10 on 1.8.0_291-b10 +jit [mswin32-x86_64]

如果你忘记将路径添加到环境变量了。

可以将jruby的安装路径bin文件夹。手动添加到系统path下面。

类似:D:\jruby-9.3.0.0\bin 路径。

2.安装 Gollum

安装gollum就很简单了。因为我们已经搭建好了ruby环境。那么我们就可以直接在命令行里面输入 安装指令:gem install gollum 进行安装了

效果:

C:\Users\Zinyan>gem install gollum

输入后,回车就会自动开始安装了

输入效果:

Fetching useragent-0.16.10.gem
Fetching therubyrhino-2.1.2.gem
Fetching therubyrhino_jar-1.7.8.gem
Fetching uglifier-4.2.0.gem
Fetching execjs-2.8.1.gem
Fetching rack-2.2.3.gem
Fetching concurrent-ruby-1.1.9.gem
Fetching sprockets-3.7.2.gem
Fetching sprockets-helpers-1.4.0.gem
Fetching tilt-2.0.10.gem
Fetching rack-protection-2.1.0.gem
Fetching ruby2_keywords-0.0.5.gem
Fetching mustermann-1.1.1.gem
Fetching sinatra-2.1.0.gem
Fetching multi_json-1.15.0.gem
Fetching sinatra-contrib-2.1.0.gem
Fetching rb-inotify-0.10.1.gem
Fetching rb-fsevent-0.11.0.gem
Fetching sass-listen-4.0.0.gem
Fetching sass-3.7.4.gem
Fetching rss-0.2.9.gem
Fetching nokogiri-1.12.5-java.gem
Fetching octicons-12.1.0.gem
Fetching mustache-0.99.8.gem
Fetching mustache-sinatra-1.0.1.gem
Fetching kramdown-2.3.1.gem
Fetching kramdown-parser-gfm-1.1.0.gem
Fetching unf-0.1.4-java.gem
Fetching twitter-text-1.14.7.gem
Fetching rouge-3.26.1.gem
Fetching crass-1.0.6.gem
Fetching loofah-2.12.0.gem
Fetching gollum-5.2.3.gem
Fetching mime-types-1.25.1.gem
Fetching rjgit-5.7.0.2.gem
Fetching gollum-rjgit_adapter-0.6.1-java.gem
Fetching github-markup-4.0.0.gem
.... 

之后等待安装完毕。

安装完毕后,我们同样可以通过版本查看方式,检测是否安装成功

输入指令

C:\Users\Zinyan>gollum -v

得到:

Gollum 5.2.3

当前最新的版本

到这里,我们就将所有的需要安装的程序,全部准备就绪了。

下一步,就是使用gollum来管理wiki了

3. 启动gollum

启动前,需要将你的wiki 下载到本地仓库。

例如:git@xxxxxx:sdkLib/android.wiki.git 将该git路径下载到本地后将得到一个文件夹:

你可以在命令行中输入:

实例1:

C:\Users\Zinyan>gollum D:\Demo\android.wiki

然后命令行就会打印一窜的启动过程。同时会弹出java 访问网络的权限。

之后就可以在浏览器中输入:http://localhost:4567/ 打开gollum 进行wiki的编辑了。

如果你觉得上面的启动过程比较麻烦。那你还可以有下面的启动方式:

D:\Demo\android.wiki>gollum 

也就是直接进去你git得到的wiki文件夹,在文件夹下面直接执行gollum 指令就可以了。

4.编辑

通过http://localhost:4567/ 打开后你就可以自己创建wiki页面了。
创建完毕后,点击保存就可以了。

创建页面后,save后,gollum 会自动调用git脚本,将你的编辑操作进行提交。

5.invalid byte sequence in GBK 错误

输入网页后,会出现GBK 编码的错误。主要错误提示为:

ArgumentError at /gollum/create/Home invalid byte sequence in GBK

说的就是我们的编码造成的错误。我们需要修改下编码格式就可以了。

解决方法:
D:\jruby-9.3.0.0\lib\ruby\stdlib\webrick 打开这个文件夹

我的jrbuy是安装在D盘。你根据自己的文件夹打开使用。

在config.rb文件中添加编码 -- 直接使用记事本工具打开这个文件就可以

添加:Encoding.default_external = 'UTF-8' 就可以了。

效果如下: 在第11行的位置,我主动添加的。

# frozen_string_literal: false
#
# config.rb -- Default configurations.
#
# Author: IPR -- Internet Programming with Ruby -- writers
# Copyright (c) 2000, 2001 TAKAHASHI Masayoshi, GOTOU Yuuzou
# Copyright (c) 2003 Internet Programming with Ruby writers. All rights
# reserved.
#
# $IPR: config.rb,v 1.52 2003/07/22 19:20:42 gotoyuzo Exp$
Encoding.default_external = 'UTF-8'
require_relative 'version'
require_relative 'httpversion'
...

然后保存文档。重启gollum 就可以了。

备注

下面是gollum 官方出的各操作系统平台下的 安装方式。我只是针对windwos 进行了丰富拓展而已。

Installation · gollum/gollum Wiki (github.com)

2

评论区