How can I omit a heading from TOC?

[damusix]

For example, it doesn't make sense to include the first h1 since it's always at the top of the page

[cmaas]

You can't exclude a single heading. You can only exclude all headings of a type, for example, all h1:

const md = new MarkdownIt();
md.use(markdownItTOC, {
  "includeLevel": [2,3,4]
});

I do not plan to add support to exclude specific headings, because it's kinda weird. Markdown has no concept of a querySelector. The source document is Markdown, not HTML. You can't easily specify which headline you want to exclude.

If you want more fine-grained control, I recommend to move the TOC generation to the client by using my client-side web component: https://github.com/cmaas/table-of-contents-element

This way, you have full access to the DOM and can pass a querySelector as an attribute to exclude headings with a certain ID, class etc.

[damusix]

@cmaas In VSCode, the all in one markdown plugin allows you to omit by inserting an html comment <!-- omit from toc -->. I too think excluding all h1's would be awkward, but it would be useful to exclude some that don't contribute anything meaningful to the TOC.

EG:

Some main title

• Some main title
  • Some sub title
  • Some other sub title

---

Everyone can agree that's kind of awkward to get scrolled to above the TOC.

[cmaas]

Good idea, I added this as you suggested in the just released version 0.9.0