markdown-toc
markdown-toc copied to clipboard
jonschlinkert
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,...
`markdown-toc` will include headers that are inside of HTML comments (``), as is allowed in [GitHub Flavored Markdown](https://github.github.com/gfm/#example-644). ## Steps to reproduce `sample.md` ``` # Header 1 listed # Header...
`test.md` : ````markdown # One ```python #!/bin/python print("hello world") ``` ## two hello world ### Three hello world # Test test ## Hello hi ```` type `./cli.js test.md --number `...
Da when I use the command: "npx markdown-toc -- no-firsth1 -- bullets " * " --maxDepth 1 README.md" to generate the readme's directory, it is found that the generated directory...
See: https://stackoverflow.com/questions/69898244/cannot-statically-analyse-require-in-line-16 **Problem:** When importing markdown-toc in nextjs I am getting the issue. /pages/index.js `import toc from "markdown-toc";` Then I got the below error > ./node_modules/markdown-toc/lib/utils.js > Cannot statically analyse...
``` let toc = require('markdown-toc'); sample = ` - old toc 1 - old toc 2 - old toc 3 ## abc This is a b c. \`\`\`\` \`\`\`\` ##...
Hello, When the ToC is generated, some characters ('/', '(', ')') are replaced with '-' but that breaks the link. Instead they should be simply removed. Examples: - `Something (else)`...
I believe the intention here is to install this package globally so we can use it across all projects. `--save` wasn't working for me at all, while `-g` installed it...
Example without the option: ``` $ npx markdown-toc README.md - [my-project](#my-project) - [Getting started](#getting-started) - [Usage](#usage) * [Example](#example) - [API](#api) * [The `` element](#the--element) + [Attributes/Properties](#attributesproperties) + [Methods](#methods) + [Events](#events)...
In reference to #109 Here's what I have so far. The code might not be the greatest, but I thought it would be best to get down a starting point...
Metadata
Owner
Metadata
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,...