marked-custom-heading-id
Specify a custom heading id in headings with the Markdown Extended Syntax # heading {#custom-id}
The heading will be rendered with the string between {# and }
The id must be a valid id with the following criteria:
- Must start with a letter (
A-Z,a-z) - Must only contain word characters (
A-Z,a-z,0-9,_) or dashes (-)
Usage
import { marked } from "marked";
import customHeadingId from "marked-custom-heading-id";
// or UMD script
// <script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
// <script src="https://cdn.jsdelivr.net/npm/marked-custom-heading-id/lib/index.umd.js"></script>
marked.use(customHeadingId());
marked("# heading {#custom-id}");
// <h1 id="custom-id">heading</h1>
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)
![github-actions[bot]](https://avatars.githubusercontent.com/u/41898282?size=120)
