-
Notifications
You must be signed in to change notification settings - Fork 0
README
This is a git-backed wiki and you have several options when it comes to viewing or modifying the wiki.
You can use github's web interface to view and edit the wiki, but please stick to the markdown file format when creating and editing files.
In order to view/edit files locally you must first obtain a copy of the source.
Use git clone repo_url to fetch a copy. At this point you can view and edit
the wiki files using and plain text editor but in order to see how the files
are rendered as HTML you must install golum
and markdown.
$ [sudo] gem install gollum
$ [sudo] gem install rdiscount
You can quickly render any of the individual markdown files in the wiki by using a command like:
$ rdiscount README.md > README.html
$ open README.html
Please note that only gollum will render inter-wiki links correctly. Even so,
rdiscount is useful for quickly rendering individual files.
gollum has a built in web-server and allows you to view and edit the
wiki directly from your web browser. When you save a change using gollum,
those changes will be committed to your local repository. Also be aware that any
file changes you make outside of gollum will not be visible to gollum until
those changes are committed to the repository. To run the gollum server, just
cd into the wiki directory and enter:
$ gollum
At this point you can open a browser and go to http://localhost:4567 to access the wiki.