How To

How to work with this github wiki

Edit online or clone

• You can contribute by creating new pages straight in the gitbub I7 Trove Wiki.
• When you edit pages in the wiki, the "Edit message" is the commit message. Every edit is a commit.
• You can clone the wiki as a separate git repo: git clone https://github.com/peterorme/i7-trove.wiki.git

Commit and push? Fork? Branch? Pull Requests?

The wiki is a git repo, but github does not seem to support doing pull requests for wiki changes. You can branch, but I think you can only see the master branch in the wiki UI. Anyway, pull requests seem a bit overkill.

Using folders and special pages

• Please don't use folders in the wiki. It kind of works, but if there are conflicting pages (with the same file name but in different folders) you can't get to one of them, as the wiki UI flattens the view.
• The side bar is a special page called _Sidebar.md. It shows everywhere.
• The footer is a special page called _Footer.md. It also shows everywhere.

Using Categories (experimental)

This is experimental. But the Categories.md page is definitely going to be automatically generated.

Using comments in Markdown (experimental)

According to this SO post this might work. Does it?

Option 1: this thing

[//]: # (This may be the most platform independent comment)

Below is that line again.

Option 2: xml comments

<!-- What about this? Do you see this in github wiki? -->

Below is that line again.

It seems that both versions does indeed work, and both get completely removed in the html.

Categories

• category:About