Gollum 技术文档

1. 安装指南

Gollum 是一个基于 Git 的简易维基系统。以下是安装 Gollum 的步骤：

作为 Ruby Gem 安装

1. 使用 RVM 或其他包管理器安装 Ruby。
2. 运行以下命令安装 Gollum：

gem install gollum

通过 Docker 安装

有关如何通过 Docker 运行 Gollum 的说明，请参考 Gollum Docker 文档。

作为 Java Web 应用程序资源安装

Gollum 的最新版本中总是包含一个可下载的 gollum.war 文件，可以直接在任何具有 Java 安装的系统上执行：

java -jar gollum.war -S gollum <your-gollum-arguments-here>

从源代码运行

1. 克隆 Gollum 仓库：

git clone https://github.com/gollum/gollum

2. 进入 Gollum 目录：

cd gollum

3. 安装依赖项：

[sudo] bundle install

4. 运行 Gollum：

bundle exec bin/gollum

5. 在浏览器中打开 http://localhost:4567。

2. 项目使用说明

Gollum 的使用非常简单，以下是一些基本的使用步骤：

1. 确保你有一个初始化的 Git 仓库。
2. 运行 gollum /path/to/wiki 命令，其中 /path/to/wiki 是你的 Git 仓库路径。
3. 在浏览器中打开 http://localhost:4567，你将看到 Gollum 的界面。

Gollum 支持多种马克杯语言，你可以根据需要为不同的页面激活不同的马克杯语言。

3. 项目 API 使用文档

Gollum 提供了一个预定义的 API，可以通过在命令行中添加 --irb 参数来启动。这将允许你访问 Gollum 的内部 API，并进行操作。

bundle exec bin/gollum --irb

有关 Gollum API 的详细信息，请参考 Gollum API 文档。

4. 项目安装方式

Gollum 可以通过以下几种方式安装：

• 作为 Ruby Gem
• 通过 Docker
• 作为 Java Web 应用程序资源
• 从源代码

请参考上面的“安装指南”部分获取详细的安装步骤。

以上是 Gollum 的基本技术文档，希望对你有所帮助。如果你有任何问题或需要进一步的澄清，请随时提问。