Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darkmavis1980/markdown-index-generator
Parses a MarkDown document and creates an index with links using the document headings
https://github.com/darkmavis1980/markdown-index-generator
cli generator markdown typescript
Last synced: 17 days ago
JSON representation
Parses a MarkDown document and creates an index with links using the document headings
- Host: GitHub
- URL: https://github.com/darkmavis1980/markdown-index-generator
- Owner: darkmavis1980
- Created: 2020-06-10T10:24:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-31T10:06:58.000Z (4 months ago)
- Last Synced: 2024-11-07T05:10:58.842Z (about 1 month ago)
- Topics: cli, generator, markdown, typescript
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- project-awesome - darkmavis1980/markdown-index-generator - Parses a MarkDown document and creates an index with links using the document headings (TypeScript)
README
# 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
[![Version](https://img.shields.io/npm/v/md-index-generator.svg)](https://npmjs.org/package/md-index-generator)
[![Downloads/week](https://img.shields.io/npm/dw/md-index-generator.svg)](https://npmjs.org/package/md-index-generator)
[![License](https://img.shields.io/npm/l/md-index-generator.svg)](https://github.com/experimental/markdown-index-generator/blob/master/package.json)
![Build Status](https://github.com/darkmavis1980/markdown-index-generator/workflows/CI/badge.svg)## Usage
```sh-session
$ 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// Display the output on the shell
$ md-index-generator --dry-run// Store the output in a file
$ md-index-generator --output// Generate the index using only h2 and h3 headings
$ md-index-generator --depth 3// Set the title of the index, output will start with "## Docs index"
$ md-index-generator --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 ` This takes an output file, where the parsed index will be stored instead of being shown in the shell
`-d, --depth ` 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 ` 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 `` and `` in the markdown document.
Here a sample:```markdown
# Your Fancy documentThe index will go here!
## 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.