headers2md
v1.0.0
Published
Automagically generate table of contents from the headers in your markdown files
Downloads
20
Maintainers
Readme
headers2md
Automagically generate table of contents from the headers in your markdown files
Install
$ npm install --global headers2md
Usage
Example
You will most likely want to use the CLI.
Given the following readme.md
:
This is the table of contents:
<!-- START headers2md -->
<!-- END headers2md -->
# A
# B
Execute:
$ headers2md readme.md
And you will obtain:
This is the table of contents:
<!-- START headers2md -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN headers2md TO UPDATE -->
- [Install](#install)
- [Usage](#usage)
- [Changelog](#changelog)
- [Related](#related)
- [License](#license)
<!-- END headers2md -->
# A
# B
You can see an example at: aymericbeaumet/awesome-links.
API
todo
CLI
todo
Changelog
- 1.0.0
- Bump stable
Related
License
To the extent possible under law, Aymeric Beaumet has waived all copyright and related or neighboring rights to this work.