Content between TOC and next header gets removed

[pascal-mugnier-sonarsource]

If you have content between the TOC header and the next header, the plugin will remove it.

Exemple:

## Table of Contents

Some text here...

## First title

In this example, Some teext here... will get removed.

I think this can be fixed by changing this line:

node.children.slice(result.index)

to

node.children.slice(result.endIndex)

[wooorm]

Why do you think that’s a bug? IMO it’s a feature 🤷‍♂️ What else would you like to put in a toc?

[pascal-mugnier-sonarsource]

I think I was not clear enough...
Let's say you have this markdown:

## Table of Contents

This is my intro text, explaining what is on this page, lorem ipsum dolor sit amet.

## Title One
### Sub title A

Some text from Sub title A

### Sub title B

Some text from Sub title B

I would expect, with the ToC plugin, to end up with something like this:

## Table of Contents
## Title One
### Sub title A
### Sub title B

This is my intro text, explaining what is on this page, lorem ipsum dolor sit amet.

## Title One
### Sub title A

Some text from Sub title A

### Sub title B

Some text from Sub title B

But I end up with:

## Table of Contents
## Title One
### Sub title A
### Sub title B

## Title One
### Sub title A

Some text from Sub title A

### Sub title B

Some text from Sub title B

The intro text gets remove.

[wooorm]

Hmm, from all the tables of contents I’ve seen I think that they only house a list of the content. I don’t think I’ve seen alternative content being used.

Why not go with:

...

This is my intro text, explaining what is on this page, lorem ipsum dolor sit amet.

## Table of Contents

* Title One
  * Sub title A
  * Sub title B

## Title One
### Sub title A

Some text from Sub title A

### Sub title B

Some text from Sub title B

...

[pascal-mugnier-sonarsource]

Well, this can be done this way of course. But I still think this is a bug, and it can be fixed quite easily.

Paragraphs between ToC and first title should not simply disappear IMO.

[wooorm]

Currently we’re looking for a heading and replacing the whole content of that “section”. The same is done for remark-usage and remark-license. It’s used throughout the ecosystem.

Alternatively, we could look for comments, called “ranges”. See mdast-zone for more info. I believe that would be able to do what you want. I’m sure a PR to BarryThePenguin/mdast-util-toc for that support would be OK (this plugin is just a small wrapper around that).

[wooorm]

Feel free to open a PR there if you’d like to add this new feature.
I don’t see your report as a bug though.

[florianwalther-private]

I have the same problem right now. I want to have some intro text after the ToC without its own heading. Is there a way to achieve this?

[florianwalther-private]

My workaround, for now, is to add an "Intro" header to the intro section, let remark-toc skip it:

.use(remarkToc, {skip: 'Intro'})

And then I hide the h2 tag with CSS (I wanna keep the empty space):

.blogPostContainer :global(h2#intro) {
    visibility: hidden;
}

[wooorm]

The same response (#18 (comment)) still holds.

[dereckmezquita]

@pascal-mugnier-sonarsource I created my won function to use as a plugin and shared it here: #40 (comment)