md-index-generator

========================

Parses a markdown document and creates an index based on headings.

The h1 heading will be ignored as it should be used only for the main title of the document

Usage

$ npm install -g md-index-generator
$ md-index-generator COMMAND
running command...
$ md-index-generator (-v|--version|version)
1.0.0

// Replace the passed markdown file
$ md-index-generator <MarkDown.md>

// Display the output on the shell
$ md-index-generator <MarkDown.md> --dry-run

// Store the output in a file
$ md-index-generator <MARKDOWNFILE.md> --output <Index.md>

// Generate the index using only h2 and h3 headings
$ md-index-generator <MarkDown.md> --depth 3

// Set the title of the index, output will start with "## Docs index"
$ md-index-generator <MarkDown.md> --title "Docs index"

Breaking Changes

From version 1.x onward, the logic of the CLI has changed, where by default it replace the index of the source file, while before you had to explicitly use the --replace flag to do so. If you want to see the index generated on screen, you must pass the --dry-run flag instead.

Optional flags

-o, --output <VALUE> This takes an output file, where the parsed index will be stored instead of being shown in the shell

-d, --depth <VALUE> This sets the depth, with a range between 2 and 5, so if sets to 3, it will parse the headings until H3, default value is 4

-t, --title <VALUE> This set the title for the index list, by default is set to Index

-r, --dry-run This flag will show the output on screen, but it will not update the source file

Add the index in the source file

If you wish to modify the file you are passing as a source, you must add the tags <!-- index-start --> and <!-- index-end --> in the markdown document. Here a sample:

# Your Fancy document

<!-- index-start -->
The index will go here!
<!-- index-end -->

## Some more stuff

Hello

If you don't add the index tags, the script will automatically put the index before the first Heading 2 in the document. It is recommended to add the tags to properly control where the index will be added.