Package Exports
- marked-gfm-heading-id
Readme
marked-gfm-heading-id
Add ids to headings like GitHub.
Usage
import { marked } from "marked";
import { gfmHeadingId } from "marked-gfm-heading-id";
// or ES Module script
// import { marked } from "https://cdn.jsdelivr.net/gh/markedjs/marked/src/marked.js";
// import { gfmHeadingId } from "https://cdn.jsdelivr.net/gh/UziTech/marked-gfm-heading-id/src/index.js";
const options = {
prefix: "my-prefix-",
};
marked.use(gfmHeadingId(options));
marked("# heading");
// <h1 id="my-prefix-heading">heading</h1>
reset
If you want to reset the heading list between marked
calls you must call reset
.
import { marked } from "marked";
import { gfmHeadingId, reset } from "marked-gfm-heading-id";
marked.use(gfmHeadingId());
marked("# heading\n\n# heading");
reset();
marked("# heading\n\n# heading");
options
option | type | default | description |
---|---|---|---|
prefix | string | "" |
A string to prepend to all ids. |