Heading not generated in `toc` if nested within 2 or more elements (but generated if nested within 1 element)

[ManasMadrecha]

Version

@nuxt/content: v1.14.0
nuxt: v2.15.7

Steps to reproduce

<!-- This generates Heading in TOC → -->

<div>

### Heading 

</div>



<!-- This DOES NOT generate Heading in TOC → -->

<div>
<div>

### Heading 

</div>
</div>



<!-- This DOES NOT generate Heading in TOC → -->

<details>
<summary>

### Heading 
</summary>

Some content here
</details>

What is Expected?

1. Headings should be generated even if present inside some random Divs or at least if present inside summary tag. This is very common use-case while adding FAQs.

2. Or, at least an option should be given in nuxt.config.js in content as to the depth/nesting of the elements up to which Headings will be generated even if written in them

[nozomuikuta]

@ManasMadrecha

Currently, as you described, only root-level or one-deep headings are collected as parts of TOC, and it's hard-corded how deeply Nuxt Content search heading tags.

content/packages/content/parsers/markdown/index.js

Lines 47 to 50 in ea976ce

	generateToc (body) {
	const { tocTags } = this.options
	const children = this.flattenNode(body, 2)

content/packages/content/parsers/markdown/index.js

Lines 32 to 40 in ea976ce

	flattenNode (node, maxDepth = 2, depth = 0) {
	if (!Array.isArray(node.children) || depth === maxDepth) {
	return [node]
	}
	return [
	node,
	...node.children.reduce((acc, child) => acc.concat(this.flattenNode(child, maxDepth, depth + 1)), [])
	]
	}

---

1. Headings should be generated even if present inside some random Divs or at least if present inside summary tag. This is very common use-case while adding FAQs.

2. Or, at least an option should be given in nuxt.config.js in content as to the depth/nesting of the elements up to which Headings will be generated even if written in them

Whichever is accepted, it brings a new feature to Nuxt Content, which is not actively developed and is supposed to be replaced with Docus.

So, all we should do will be to notify @pi0 and @Tahul as a reference.

[nozomuikuta]

A little correction:

Nuxt Content, which is not actively developed and is supposed to be replaced with Docus

Docus doesn't completely replace Nuxt Content, as far as I know.
So what's described in this issue may be in the scope of Nuxt Content v2.

[ManasMadrecha]

Currently, as you described, only root-level or one-deep headings are collected as parts of TOC, and it's hard-corded how deeply Nuxt Content search heading tags.

@nozomuikuta So, for the time being, could you kindly change the code to at least 2 level depth? This way at least the headings inside the <summary> tag will be generated in TOC 😋

[nozomuikuta]

@ManasMadrecha

Actually, I can't because I'm just a collaborator. All I can do is to submit PRs like other people in community.

Additionally, I believe the maintainer also won't do that instantly because it's basically a breaking change.

Generally, once software reaches to v1, and the more people start to use it, maintainer has to take the more factors into consideration, such as balancing between what to do and what not to, maintainability, performance, and impacts of changes on the existing users and their projects, and so on.

In summary, for the time being, you can utilize patch-package to modify the package code only in your project.

They may handle your concern in Nuxt Content v2 or Docus since I notified them in the comment above.

I hope this would help.

[Tahul]

Hello!

Configuring toc depth is now an option in @nuxt/content v2:

export default defineNuxtConfig({
  content: {
    toc: {
  	   depth: 2,
  	   searchDepth: 2
	}
  }
})

I am closing this as we are moving priority support to @nuxt/content v2 and this is supported there!

Feel free to re-open with an PR targeted at v1 branch if you want this to be fixed in v1.

[ManasMadrecha]

@Tahul Amazing. That solves my request.