Skip to content

Instantly share code, notes, and snippets.

@guilhermechapiewski
Forked from tekkub/github_wiki_toc.js
Created April 26, 2010 15:28
Show Gist options
  • Save guilhermechapiewski/379469 to your computer and use it in GitHub Desktop.
Save guilhermechapiewski/379469 to your computer and use it in GitHub Desktop.
Create a "Table of Contents" in your Github wiki
$(function () {
var toc = $("<ul>").css("margin-bottom", "20px !important");
$("div.main div.wikistyle h2").each(function() {
var id = $(this).text().replace(/\s+/g, "_").replace(/[^0-9a-zA-Z_.-]/g, "")
$(this).attr("id", id)
toc.append(
$("<li>").append($("<b>").append($("<a>").attr("href", "#" + id).text($(this).text())))
)
});
$("div.wikistyle").prepend(toc).prepend($("<h2>").text("Table of Contents"));
})
@ciathyza
Copy link

How do I use this? Or where do I put it to make it work?

@zdennis
Copy link

zdennis commented May 9, 2011

@MarioRicalde
Copy link

I developed GitHub Wikifier: A pre-commit Git Hook that will generate all the Table of Contents you will ever need. Just write your content, and let it take over. May be worth a check. https://github.com/kuroir/GitHub-Wikifier

@dogweather
Copy link

You can get auto-generated TOC by using doc type AsciiDoc and inserting :toc:.

@sdake
Copy link

sdake commented May 10, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment