Get markdown-toc on macOS and Linux Now!
API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files. Uses Remarkable to parse markdown. Used by NASA/openmct, Prisma, Joi, Mocha, Sass, Prettier, Orbit DB, FormatJS, Raneto, hapijs/code, webpack-flow, docusaurus, release-it, ts-loader, json-server, reactf
Get markdown-toc with one command
Pick your system, reveal the step-by-step guide, copy the command, paste it into your terminal and press Enter. This command comes from the project's public source.
Not available for Windows yet.
markdown-toc doesn't publish an install command for Windows anywhere we can verify, so there's nothing for us to show you. We won't invent one. It does document one for macOS and Linux — switch to that tab.
Pastes into PowerShell and installs markdown-toc on your Windows machine in one step. Runs as your normal user account, and needs no administrator rights.
Not available for macOS yet.
markdown-toc doesn't publish an install command for macOS or Linux anywhere we can verify, so there's nothing for us to show you. We won't invent one.
Installs markdown-toc on your macOS or Linux machine and links it into your PATH — after this,
markdown-toc just works from any directory. Runs as your normal user account, and needs no administrator rights.
How to set up markdown-toc, step by step
Open Terminal. On a Mac it's in Applications ▸ Utilities, or press Cmd+Space and type Terminal. On Linux, press Ctrl+Alt+T. Paste the command and press Enter.
Run markdown-toc --help to see the available commands, and
markdown-toc --version to confirm the install worked. If your shell complains about
permissions, that project usually documents a corrected command on its own site.
This asks Homebrew to fetch markdown-toc and link it into /opt/homebrew/bin (Apple Silicon) or /usr/local/bin (Intel), so you can run it by name.
markdown-toc at a glance
- Installs with a single
command —
Homebrew. - Installs on macOS / Linux.
- Free and open source, with no paid tier and no account needed.
- 1.8k stars — an actively used project.
markdown-toc doesn't publish a feature list we can quote, so this is what we verified ourselves.
About markdown-toc
API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files. Uses Remarkable to parse markdown. Used by NASA/openmct, Prisma, Joi, Mocha, Sass, Prettier, Orbit DB, FormatJS, Raneto, hapijs/code, webpack-flow, docusaurus, release-it, ts-loader, json-server, reactf
| Category | Server / service |
|---|---|
| Install method | Homebrew |
| Windows | no install command published |
| macOS / Linux | documented install command available |
| Price | Free and open source |
| Command verified | From project source |
| Popularity | 1.8k stars on the project's public repository |
On mobile
markdown-toc is a command-line tool, so there is no phone app for it — a phone has no shell to run it in. You'll need a desktop, or a remote shell into a machine that has one.
markdown-toc is developed by its own authors. This page is an independent reference; we are not affiliated with or sponsored by the project. The command shown here was reproduced from the project's public documentation — always check the project's own documentation before running anything.