https://github.com/funnyhcat-dotcom/readme-toc-genie
Generate and update Markdown table of contents blocks.
https://github.com/funnyhcat-dotcom/readme-toc-genie
cli developer-tools documentation markdown nodejs readme table-of-contents toc
Last synced: about 10 hours ago
JSON representation
Generate and update Markdown table of contents blocks.
- Host: GitHub
- URL: https://github.com/funnyhcat-dotcom/readme-toc-genie
- Owner: funnyhcat-dotcom
- License: other
- Created: 2026-06-28T23:46:07.000Z (about 12 hours ago)
- Default Branch: main
- Last Pushed: 2026-06-28T23:46:14.000Z (about 12 hours ago)
- Last Synced: 2026-06-29T00:06:06.289Z (about 11 hours ago)
- Topics: cli, developer-tools, documentation, markdown, nodejs, readme, table-of-contents, toc
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# readme-toc-genie
Generate and update Markdown table of contents blocks.
A tiny zero-dependency CLI for keeping long README files, docs pages, and guides easy to navigate.
## Quick start
```bash
npx readme-toc-genie README.md
```
```bash
# update README.md in place
npx readme-toc-genie README.md --write
# only include h2 and h3 headings
npx readme-toc-genie docs/guide.md --min-depth 2 --max-depth 3
# JSON for automation
npx readme-toc-genie README.md --format json
```
## Markers
`--write` inserts or updates this block:
```md
...
```
## Features
- GitHub-style heading slugs
- duplicate heading handling
- ignores headings inside fenced code blocks
- configurable min/max heading depth
- markdown and json output
## License
MIT