Editing the Wiki

The built-in Github wiki is implemented using [gollum][2]. For more complex editing it's possible to clone the wiki and work locally. The basic structure of the wiki is

• /Home.md -- The home page that appears when users click on [the wiki link][3].
• dev/ -- Pages relating to the development of Albacore.
• tasks/ -- Detailed documentation of each task.

Getting Started

1. Clone the wiki repository using the [writeable SSH address][1].

   $ git clone git@github.com/...

2. Install the gollum wiki and Markdown markup format gems.

   $ gem install gollum
   $ gem install rdiscount

3. Run Bundler to install all of the wiki prerequisites.

   $ bundle

4. Start a local gollum webserver on http://127.0.0.1:4567 to preview the latest commited changes. Don't forget to git commit before you run gollum!

   $ bundle exec gollum

Task Pages

• Each task should have its own page located in tasks/MyTaskName-Task.ext.
• Images for each project should be placed into the tasks/images/task-name/ directory.
• The sidebar _Sidebar.md should be updated with a link to the task.

Follow the Markdown template below for each task page.

# The Task Name

A description of the task and a sample of the task using the most likely properties.

```ruby
customtask :name do |x|
  x.some_property = 'some/path/value'
  x.another_property = 'foo'
end

 [1]: https://github.com/Albacore/albacore/wiki/_access
 [2]: https://github.com/gollum/gollum#gollum----a-wiki-built-on-top-of-git
 [3]: http://github.com/Albacore/albacore/wiki