Skip to content

Table of Contents for GitHub wiki ~ AsciiDoc

AndyGlew edited this page Nov 13, 2020 · 3 revisions

Good news: it seems that GitHub handles AsciiDoc :toc: and toc::[] directives in the code repo.

Bad news: but not in the wiki. :-( #

Use AsciiDoc instead as per suggestion from this comment. https://github.com/isaacs/github/issues/215#issuecomment-336328746

Here is an example in one of my own repos: https://github.com/littlebits/react-popover/blob/master/README.adoc

There are lots of nice little things about AsciiDoc but only its good TOC functionality for me typically warrants the change to another markup language. I’d love to be able to stay with markdown and win from the great tool/editor support etc.. For now though AsciiDoc has been working well for me.

For example:

Title

Table of contents should go just below here

Table of contents should go just above here

A

A2

B

B2

Check the example at littlebits/react-popover (README.adoc).

Clone this wiki locally