Wiki Settings

Properties

Each Gollum wiki can store individual settings in the settings.yml file at the root of the repository. This file can store the following options:

• title - The title of the wiki. This is displayed at the top of each page.
• source_url - The URL for the source code project that this wiki represents.
• ribbon - Enables the GitHub ribbon. This field takes two space-separated values: color and position. Valid color values are: red, green, darkblue, orange, gray and white. Valid position values are: left and right. If the position is omitted then it defaults to right. If a non-valid color value is specified the it is assumed to be a relative or absolute URL. Note that the source_url is required in order to show the ribbon.
• tracking_id - Your Google Analytics tracking id. The Google Analytics JavaScript tracking code will be inserted into your page automatically.
• menu - An array of menu items. Each menu item should have a title and an href property set. The href can specify another page in the wiki or a URL outside of the wiki.

Example

This is an example of the settings.yml file used for Smeagol:

title: Smeagol
source_url: http://github.com/benbjohnson/smeagol
ribbon: red right
tracking_id: UA-1234567-8

menu:
  - title: Home
    href: /
  - title: Command Line
    href: /Command-Line-Interface
  - title: Settings
    href: /Settings
  - title: Templates
    href: /Templates
  - title: Misc
    href: /Miscellaneous