Adding a custom sidebar to Github Wiki with automated ordering based on line entries

2

May 28, 2015 by Nikos

This is a small and trivial thing but surprisingly there’s no guide to do it.

Writing wikis you likely want to establish a specific reading order for your pages.

The Pages dropdown widget contains all pages with an alphabetical order and its the default “Sidebar/Table of Contents” that Github Wikis provide. There’s no ready solution to custom ordering by Github wikis. Even though something like reordering by dragging Pages around in the Pages widget would be trivial for the Github wizards to make…

In order to create your very own and custom Table of Contents with auto updated ordering depending on the line you define each entry, create a custom Sidebar exactly like Github suggests.

In the main body write :

//Edit <Username> and <Project Name> to reflect your situation
1.[Home](https://github.com/<Username>/<Project Name>/wiki)
+ [<FirstPageName>](https://github.com/<Username>/<Project Name>/wiki/<FirstPageName>)
+ [<SecondPageName>](https://github.com/<Username>/<Project Name>/wiki/<SecondPageName>)
+ [<ThirdPageName>](https://github.com/<Username>/<Project Name>/wiki/<ThirdPageName>)

Ordering starts from index 1 with the Home page which is the default wiki entrance. Everything else will just get the +1 index from the previous line’s index. So inserting a page between SecondPage and ThirdPage you just copy-paste a new line between them,edit the name and link and Github’s Markdown will take care of the numbering on the left.

Advertisements

2 thoughts on “Adding a custom sidebar to Github Wiki with automated ordering based on line entries

  1. I will really book mark this page…Thanks for sharing this information!!

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Copyright

© Nikolaos Patsiouras and Adventure Game Adventures, 2013. Unauthorized use and/or duplication of this material without express and written permission from this blog’s author and/or owner is strictly prohibited. Excerpts and links may be used, provided that full and clear credit is given to Nikolaos Patsiouras and Adventure Game Adventures with appropriate and specific direction to the original content.
Anteru's blog

Graphics, programming & software engineering

Mike Taulty

I do some developer stuff for Microsoft UK

Geoff Lester | Technical Artist

Game Development, CGI and Programming

Andrew Fray

On games programming and AI

Fuzzy Reflection

Personal Space for Self-Reflection

ScrawkBlog

Game programming and asset creation

bitsquid: development blog

blog about my projects,thoughts and other stuff

Graphics in Plain Language

blog about my projects,thoughts and other stuff

tavianator.com

blog about my projects,thoughts and other stuff

Andreas on Coding

Thoughts about programming.

Aras' website

blog about my projects,thoughts and other stuff

duangle

blog about my projects,thoughts and other stuff

extremeistan

thoughts about computer graphics, game engine programming

The ryg blog

When I grow up I'll be an inventor.

Coding in the Dark

A technical blog of game development.

Dan Luu

blog about my projects,thoughts and other stuff

Molecular Musings

Development blog of the Molecule Engine

%d bloggers like this: