Book Image

GitLab Cookbook

By : Jeroen van Baarsen
Book Image

GitLab Cookbook

By: Jeroen van Baarsen

Overview of this book

Table of Contents (16 chapters)
GitLab Cookbook
About the Author
About the Reviewers

Managing your wiki with Gollum

The wiki in GitLab can be managed via the web interface, but it is also possible to edit it locally using the Gollum gem. In this recipe, we will take a look at what is needed to get the wiki running on your local machine, make a change, and push it back to GitLab.

Getting ready

To follow this recipe, you need to have Ruby installed on your system, and you need the permissions to install new gems on your machine. Also, you need to have a project in GitLab that has at least one wiki page.

How to do it…

Let's create a wiki article using Gollum with the following steps:

  1. Install Gollum on your local machine. This might take a while:

    gem install gollum
  2. Now, clone the wiki. You can find the Git URL in the top-right section on the wiki page of your project.

  3. You can clone the project just like any other Git project.

  4. Go to the folder you just cloned.

  5. Enter the gollum command. This will start the Gollum server so that you can watch your changes in your browser.

  6. When you go to...