macOS
Homebrewverified · 100%
brew install markdown-toclocal Homebrew formula metadata
brew / rank 5017
Install markdown-toc with Homebrew, Nix
Generate a markdown TOC (table of contents) with Remarkable. Version 1.2.0 via Homebrew; verified from local package data. Also installable with nix: nix profile install nixpkgs#markdown-toc.
install
Additional install commands
Linux
Nixverified · 92%
nix profile install nixpkgs#markdown-tocnixpkgs package indexes · pkgs/by-name/ma/markdown-toc/package.nix · source: api.github.com
overview
Package summary
Generate a markdown TOC (table of contents) with Remarkable
Project links
Commands and aliases
- markdown-toc
history
Project history and usage
markdown-toc is a Node.js API and CLI for generating and inserting tables of contents in Markdown files.
Project history
The GitHub repository was created in 2013. The README describes markdown-toc as a tool that uses Remarkable to parse Markdown and can be used from the command line or as an API/plugin.
The project belongs to the ecosystem of README automation tools around Jon Schlinkert's packages, Verb, and Assemble-style documentation workflows. Its own README is generated with Verb using markdown-toc, making the package self-demonstrating.
Adoption history
The official repository description says the package is used by many well-known projects and thousands of other projects. The README displays npm version/download badges and documents npm installation, while supplied package facts show Homebrew and Nix packaging as well.
How it is used
The common CLI workflow is to install markdown-toc globally, add a hidden <!-- toc --> marker to a README, and run markdown-toc -i README.md to inject or update the generated TOC. Without in-place mode, the CLI can print a TOC to standard output or JSON.
As an API, markdown-toc returns rendered content plus token data so build scripts can render a custom table of contents. Options cover heading depth, bullet style, slugification, filtering, indentation, and whether to include the first H1.
Why package nerds care
markdown-toc is a classic small Unixy documentation helper: it reads Markdown, emits Markdown, and is easy to wire into README generation. Package maintainers care because it has a stable CLI surface and also doubles as a library for build-time documentation automation.
Timeline
- 2013: GitHub repository created.
- 2010s: README documents npm installation and CLI/API usage for README table-of-contents generation.
- 2026: Supplied package facts list Homebrew and Nix packaging.
Related projects
- The README identifies Remarkable as the Markdown parser used by markdown-toc.
- The README notes it was generated with Verb and can be used as a Remarkable plugin.
Sources
- https://api.github.com/repos/jonschlinkert/markdown-toc
- https://github.com/jonschlinkert/markdown-toc
- source_facts.package-manager
security posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew bottle metadata was recorded.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
markdown-toc | executable | indexed executable | Discovered from the local executable index. |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-08-03
manager version1.2.0
manager updated
local dataunknown
upstreamnot available
latest detectednot detected
- okNo freshness warnings were generated.
install metadata
Package metadata
| Package key | brew:markdown-toc |
|---|---|
| Version | 1.2.0 |
| Package manager | Homebrew |
| Homepage | https://github.com/jonschlinkert/markdown-toc |
| Bottle | not recorded |
| Service | none declared |
source database matches
Other package-manager records
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
Nix95%
markdown-toc
nix profile install nixpkgs#markdown-toc- normalized package name match
- Matched by: Markdown Toc
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- cross-ecosystem install command graph
- curated package history
- external package-manager database matches
- pkg.so package database
- pkgdb category and tag curation