Automatic TOC in github-flavoured-markdown

Question

Is it possible to generate an automatic Table of Contents using Github Flavoured Markdown?

Answer 1

Gitdown is a markdown preprocessor for Github.

Using Gitdown you can:

• Generate Table of Contents
• Find dead URLs and Fragment Identifiers
• Include variables
• Include files
• Get file size
• Generate Badges
• Print Date
• Print information about the repository itself

Gitdown streamlines common tasks associated with maintaining a documentation page for a GitHub repository.

Using it is straightforward:

var Gitdown = require('gitdown');

Gitdown
    // Gitdown flavored markdown.
    .read('.gitdown/README.md')
    // GitHub compatible markdown.
    .write('README.md');

You can either have it as a separate script or have it as part of the build script routine (such as Gulp).