Editing this wiki locally

Editing this wiki locally

In order to easily work on this wiki with the editor of your choice, you can install locally the engine behind Github's wiki system.

Requirements

• Ruby

Steps

1. Install Gollum and its Markdown parser: sudo gem install gollum redcarpet
2. Clone the EasySOA wiki (which is itself a Git repository): git clone git@github.com:easysoa/EasySOA.wiki.git
3. From the folder where you cloned the wiki, run: gollum
4. Go to http://localhost:4567 to browse your local version to the wiki.
5. Edit the .md files, commit them, preview them and push!

FAQ

• Q: Nested lists don't appear as expected on the local version.
  • A: Try to add "li ul { margin-left: 20px !important; }" to /usr/lib/ruby/gems/gollum-2.0.0/lib/gollum/frontend/public/gollum/css/template.css.
• Q: The pages are not updated after I edit them.
  • A: The engine use the HEAD commit from your repository. Did you commit your changes? (a fast way to do so is to use git commit -am "edit")