Wiki Contributions

Markdown

The markdown flavor we use is Kramdown. Its very similar to most markdown flavors. If you are new to markdown I recommend the Github markdown tutorial.

Reporting Issues

Issues can be reported on the Github page of the wiki. But I highly discourage you from doing so. Instead fix the issue and submit code. We don’t have an individual assigned to maintaining the wiki so don’t be a lazy bum.

Making Modifications

You can make changes on the Github page of the wiki directly by clicking the edit button within Github. You can also simply clone the repository and make modifications locally. You however won’t be able to see the site update before submitting it with the previously mentioned options. The weight option is used to order the navigation bar. The higher the number the lower it will appear in the list.

Adding Pages

There are 3 types of pages: renderer, engine and common. These are collections. You create a new page into a collection by creating a new markdown file inside the corresponding folder.

_common // Common Collection
_engine // Engine Collection
_renderer // Renderer Collection

I recommend you duplicate an existing page and modify the font-matter to suite the new page. This prevents you from forgetting important information when creating a new page.

Live Previewing

I recommend you install Ruby, Rubygems and Jekyll to preview the changes you are making. This is especially helpfull if you are working on CSS, HTML or working with in-website links.

You are required to clone the repository locally for this.

You can find detailed instructions on how to set up Jekyll on their website.

Questions About The Wiki?

Ask Viktor Zoutman for help if you run into any issues with Jekyll or the wiki.