https://github.com/hellerve/markdown-toc
A zepto-based TOC generator for Markdown files
https://github.com/hellerve/markdown-toc
Last synced: about 1 month ago
JSON representation
A zepto-based TOC generator for Markdown files
- Host: GitHub
- URL: https://github.com/hellerve/markdown-toc
- Owner: hellerve
- Created: 2016-05-10T15:20:19.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-30T11:48:15.000Z (over 9 years ago)
- Last Synced: 2025-08-23T21:19:18.251Z (7 months ago)
- Size: 1000 Bytes
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markdown toc
A small zepto-based TOC generator for Markdown files.
This README's TOC was generated with it.
##Table Of Contents
* [markdown toc](#markdown-toc)
* [Table Of Contents](#table-of-contents)
* [Usage](#usage)
* [Why?](#why)
* [Caveats](#caveats)
## Usage
```
zepto main.zp README.md
```
## Why?
Because I wanted to. There is no reasonable explanation,
it is neither faster, easier to use or more reliable than
other tools.
It is ~20 lines long, though, which is quite cool.
## Caveats
It only parses pound-sign based headings, because I mostly use
those. It could be easily generalized, I guess, but I did not
need to yet.
Have fun!