Gollum 项目安装与使用教程

1. 项目目录结构及介绍

Gollum 项目的目录结构如下：

gollum/
├── bin/
├── contrib/
├── lib/
├── licenses/
├── test/
├── .gitattributes
├── .gitignore
├── CONTRIBUTING.md
├── Dockerfile
├── Gemfile
├── HISTORY.md
├── LATEST_CHANGES.md
├── LICENSE
├── README.md
├── Rakefile
├── config.rb
├── config.ru
├── docker-run.sh
├── gollum.gemspec
├── package.json
└── yarn.lock

目录介绍：

• bin/: 包含 Gollum 的可执行文件。
• contrib/: 包含一些贡献者的脚本和工具。
• lib/: 包含 Gollum 的核心代码。
• licenses/: 包含项目使用的各种许可证文件。
• test/: 包含项目的测试代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 构建文件。
• Gemfile: Ruby 依赖管理文件。
• HISTORY.md: 项目历史记录。
• LATEST_CHANGES.md: 最新更改记录。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• Rakefile: Rake 任务配置文件。
• config.rb: Gollum 配置文件。
• config.ru: Rack 配置文件。
• docker-run.sh: Docker 运行脚本。
• gollum.gemspec: Gollum 的 gem 规范文件。
• package.json: Node.js 依赖管理文件。
• yarn.lock: Yarn 锁定文件。

2. 项目启动文件介绍

Gollum 的启动文件主要包括以下几个：

• bin/gollum: Gollum 的可执行文件，用于启动 Gollum 服务。
• config.ru: Rack 配置文件，用于配置 Gollum 的 Rack 环境。
• docker-run.sh: Docker 运行脚本，用于在 Docker 环境中启动 Gollum。

启动方式：

1. 直接启动:

   gollum /path/to/wiki
   

   其中 /path/to/wiki 是你的 Git 仓库路径。

2. 通过 Docker 启动:

   docker run -v /path/to/wiki:/wiki -p 4567:4567 gollum/gollum
   

3. 通过 Rack 启动:

   rackup config.ru
   

3. 项目配置文件介绍

Gollum 的配置文件主要包括以下几个：

• config.rb: Gollum 的主配置文件，用于配置 Gollum 的各种选项。
• Gemfile: Ruby 依赖管理文件，定义了 Gollum 运行所需的 Ruby 库。
• gollum.gemspec: Gollum 的 gem 规范文件，定义了 Gollum 的 gem 信息。

config.rb 配置示例：

Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES

Precious::App.set(:gollum_path, '/path/to/wiki')
Precious::App.set(:default_markup, :markdown)
Precious::App.set(:wiki_options, {
  :live_preview => true,
  :allow_uploads => true,
  :per_page_uploads => true
})

配置选项说明：

• gollum_path: 指定 Gollum 的 Git 仓库路径。
• default_markup: 设置默认的页面标记语言。
• wiki_options: 配置 Gollum 的其他选项，如实时预览、文件上传等。

通过这些配置文件，你可以自定义 Gollum 的行为和功能，以满足你的需求。