https://github.com/nok/markdown-toc
Generate and update magically a table of contents based on the headlines of a parsed markdown file.
https://github.com/nok/markdown-toc
Last synced: 3 months ago
JSON representation
Generate and update magically a table of contents based on the headlines of a parsed markdown file.
- Host: GitHub
- URL: https://github.com/nok/markdown-toc
- Owner: nok
- License: mit
- Created: 2014-11-14T13:42:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-04-02T15:25:42.000Z (over 6 years ago)
- Last Synced: 2025-03-28T22:23:41.836Z (3 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 468 KB
- Stars: 68
- Watchers: 4
- Forks: 37
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Markdown TOC
============
Generate and update magically a table of contents based on the headlines of a parsed [markdown](http://en.wikipedia.org/wiki/Markdown) file.
## Table of Contents
- [Usage](#usage)
- [Installation](#installation)
- [Features](#features)
- [Contributors](#contributors)
- [Questions?](#questions)
- [License](#license)
## Usage
## Installation
```bash
apm install markdown-toc
```
## Features
- Auto linking via anchor tags, e.g. `# A 1` → `#a-1`
- Depth control [1-6] with `depthFrom:1` and `depthTo:6`
- Enable or disable links with `withLinks:1`
- Refresh list on save with `updateOnSave:1`
- Use ordered list (1. ..., 2. ...) with `orderedList:0`
## Contributors
Thanks to all contributors for any fix or improvement, whether small or large.
- [Giacomo Bresciani](https://github.com/brescia123)
- [Kévin Lanceplaine](https://github.com/lanceplaine)
- [Ilya Zelenin](https://github.com/wyster)
- [spjoe](https://github.com/spjoe)
- [Tom Byrer](https://github.com/tomByrer)
- [betrue12](https://github.com/betrue12)
## Questions?
Don't be shy and feel free to contact me on [Twitter](https://twitter.com/darius_morawiec).
## License
The package is Open Source Software released under the [MIT](LICENSE.md) license.