markdown-toc
markdown-toc copied to clipboard
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,...
The instructions say to install like this: ```bash $ npm install --save markdown-toc ``` and then use it from the command line like this: ``` markdown-toc [options] ``` But the...
I would like to be able to run this command: ``` > markdown-toc --no-first1 -i *.md ``` To automatically add TOCs to all markdown files in a repository. It doesn't...
I have following function: ``` createToc(doc) { const options = {} const toc = require('markdown-toc'); return Promise.resolve().then(() => { return new Remarkable() .use(toc.plugin(options)) .render(doc); }); } ``` When building the...
[markdown-toc](https://atom.io/packages/markdown-toc) from atom inlines the configuration of the TOC. Example: ``` - [Contents](#contents) ... ``` Is it possible to support a subset of that? I would propose: ``` ``` Depends...
Hello, I would like to generate a toc from a directory of files and insert the toc into the project's readme file, but I do not quite understand how to...
ToC not generated correctly half of the time for duplicate mardown headings with inline a tags such as: `# h1 ` `## h1 `
```bash #!/usr/bin/env bash echo hello; ``` The `#!/usr/bin/env bash` line is interpreted as a heading and added to the TOC.
Hi Jon, In the current API is it possible to get the contents (paragraphs) along with the TOC? Thanks in advance Amit
Created the following minimal script which works fine when I uncomment the `toc.plugin` line, but fails otherwise with `TypeError: Invalid non-string/buffer chunk`. After browsing the documentation of Remarkable and this...