Add table of contents configuration

[airtonix]

i want it to ignore the h1 , or

i want it to ignore headings that are specially tagged/annotated with some non renderable syntax.

[artempyanykh]

Hi @airtonix !

i want it to ignore the h1

This should be pretty straightforward.

specially tagged/annotated with some non renderable syntax

Could you give an example?

[airtonix]

Some ideas:

Control exactly where to start from

# Title

<!-- toc:start from(#something) -->
- [Something](#something-1)
- [Something](#something-2)
- [Something](#something-3)
  - [Darkside](#darkside)
<!-- toc:end -->

## Something 

words words words

## Something 

words words words

## Something 

words words words

### Darkside

words words words

if we could support for custom heading ids:

# Title

<!-- toc:start from(#something-last) -->
- [Something](#something-last)
  - [Darkside](#darkside)
<!-- toc:end -->

## Something 

words words words

## Something 

words words words

## Something {#something-last}

words words words

### Darkside

words words words

Vaguely specify tags to exclude

# Title

<!-- toc:start from(.h2) -->
- [Something](#something-1)
- [Something](#something-2)
- [Something](#something-last)
  - [Darkside](#darkside)
<!-- toc:end -->

## Something 

words words words

## Something 

words words words

## Something {#something-last}

words words words

### Darkside

words words words

ability to ignore certain headind instances

# Title

<!-- toc:start from(.h2) ignore(#something-1) -->
- [Something](#something-2)
- [Something](#something-last)
  - [Darkside](#darkside)
<!-- toc:end -->

## Something 

words words words

## Something 

words words words

## Something {#something-last}

words words words

### Darkside

words words words

or

# Title

## Intro

<!-- toc:start from(.h2) ignore(#something-unimportant, #intro) -->
- [Something](#something-1)
- [Something](#something-last)
  - [Darkside](#darkside)
<!-- toc:end -->

## Something 

words words words

## Something {#something-unimportant}

words words words

## Something {#something-last}

words words words

### Darkside

words words words

[artempyanykh]

@airtonix I like that, thanks for writing it down!

[chrisgrieser]

I also support this. No need to reinvent a new syntax though, there are some editor plugins that do something very similar, one could maybe just copy their syntax?

the MarkdownTOC plugin for Sublime, for example, has syntax for various things suggested in this issue

[austinbutler]

I guess everyone has their own way.

https://github.com/yzhang-gh/vscode-markdown/blob/0b75960d5d27f9e7d20960290e03e7127223de42/README.md?plain=1#L62

[ficd0]

I'd love to see this feature, too. I think introducing syntax for the actual Markdown document would complicate things and has a lot of potential to be controversial. A config option for .marksman.toml would be much more straightforward. Is there still interest in this feature?

[ficd0]

If there's still any interest in this, I'd like to start working on an implementation -- though I'd appreciate some help, since I don't have any F# experience. At the simplest level, I think we could implement something like toc.levels from VS Code Markdown. A config option where the user can specify a heading range (for example, 2..4) that should be included in the generated TOC. This could be set in .marksman.toml and the LSP configuration; to allow some granularity and per-project configuration.

[webdevred]

I do also want this.

[airtonix]

I'd love to see this feature, too. I think introducing syntax for the actual Markdown document would complicate things and has a lot of potential to be controversial. A config option for .marksman.toml would be much more straightforward. Is there still interest in this feature?

How i want my TOC done on one page or even part of a page may not be the way i want a toc done on another page or another part of the same page.

so no, global config that applies to everything is a non starter for me .

[ficd0]

How i want my TOC done on one page or even part of a page may not be the way i want a toc done on another page or another part of the same page.

That's a good use-case for the special syntax, thanks for sharing. I think the only problem with that approach is that it's not immediately obvious how that syntax should look; it would need some more discussion, and input from the maintainers.

IMO, one doesn't preclude the other, and we can have both features. Suppose that the option can be set globally in .marksman.toml, and also overridden per-file with a comment syntax.