Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

ToC or Sidebar in GitHub Wiki

Tags:

github

wiki

How do I create a ToC or a sidebar menu in a GitHub Wiki?

I saw some mentions of it and gollum the backend seems to support it, but how do I do it in a current GitHub project?

It should best be based on the headers I have in the page automatically.

These links all mention it, but do not show how to do it:

  • https://gist.github.com/379469 - some JavaScript hack
  • https://github.com/blog/774-git-powered-wikis-improved - GitHub mentioning it:

    "GitHub Wikis have a little-documented ability for footers and sidebars, something which some of our git-based Wiki authors are familiar with. The new Wiki editor gives you limited web-based editing of the footers and sidebars you have on your site. "

like image 675
wolle Avatar asked Feb 11 '12 10:02

wolle


People also ask

What is GitHub Wiki?

GitHub, Inc., is an Internet hosting service for software development and version control using Git. It provides the distributed version control of Git plus access control, bug tracking, software feature requests, task management, continuous integration, and wikis for every project.


1 Answers

While your solution works, there's an easier way to do it using GitHub's web interface. You can simply create a page named _Sidebar and/or _Footer.

See detailed instructions in Github Wiki sidebar menu builder with multi-level.

Edit The original article is gone and I can't find it in the cache so I've updated the link.

like image 111
nicerobot Avatar answered Oct 05 '22 10:10

nicerobot