• Description
• Installation
• Usage
  • For GitHub Wiki content
  • For selected Markdown Markup content

Description

This is a simple script that helps you create ToC in markdown markup files such as README.md or GitHub Wiki.

Installation

1. Download and install Tampermonkey plugin for your browser.
2. Click this link and confirm installation of the Tampermonkey script to your browser.

See more details about script adding in Guide how to add a script.

Usage

For GitHub Wiki content

1. Open the Wiki editor on GitHub.
2. Open the Tampermonkey toolbar and click Build ToC for Wiki content menu item. ToC will be genrated and placed to the clipboard. That will be confirmed by the corresponding notification.
3. In case of any error the corresponding error message will be displayed.

For selected Markdown Markup content

1. Open the file editor on GitHub.
2. Select the content, from which you want to create ToC.
3. Open the Tampermonkey toolbar and click Build ToC for selected Markdown Markup menu item. ToC will be genrated and placed to the clipboard. That will be confirmed by the corresponding notification.
4. In case of any error the corresponding error message will be displayed.