mdast-util-toc
Advanced tools
The `mdast-util-toc` package is a utility for generating a Table of Contents (TOC) from Markdown Abstract Syntax Trees (MDAST). It is particularly useful for processing Markdown documents and extracting a structured TOC based on headings.
Generate TOC from MDAST
This feature allows you to generate a Table of Contents from a Markdown Abstract Syntax Tree. The code sample demonstrates how to convert a Markdown string into an MDAST, generate a TOC from it, and then convert the TOC back into a Markdown string.
const { toMarkdown } = require('mdast-util-to-markdown');
const { fromMarkdown } = require('mdast-util-from-markdown');
const { toc } = require('mdast-util-toc');
const markdown = '# Title\n## Subtitle\n### Sub-subtitle';
const tree = fromMarkdown(markdown);
const tocNode = toc(tree);
console.log(toMarkdown(tocNode.map));Custom Heading Levels
This feature allows you to customize the depth of headings included in the TOC. The code sample demonstrates generating a TOC that includes only headings up to level 2.
const { fromMarkdown } = require('mdast-util-from-markdown');
const { toc } = require('mdast-util-toc');
const markdown = '# Title\n## Subtitle\n### Sub-subtitle';
const tree = fromMarkdown(markdown);
const tocNode = toc(tree, { maxDepth: 2 });
console.log(tocNode.map);Custom TOC Heading
This feature allows you to specify a custom heading for the TOC. The code sample demonstrates generating a TOC with a custom heading 'Table of Contents'.
const { fromMarkdown } = require('mdast-util-from-markdown');
const { toc } = require('mdast-util-toc');
const markdown = '# Title\n## Subtitle\n### Sub-subtitle';
const tree = fromMarkdown(markdown);
const tocNode = toc(tree, { heading: 'Table of Contents' });
console.log(tocNode.map);The `remark-toc` package is a plugin for the `remark` Markdown processor that generates a Table of Contents. It is similar to `mdast-util-toc` but is designed to be used directly within the `remark` ecosystem, making it easier to integrate if you are already using `remark`.
The `markdown-toc` package generates a Table of Contents for Markdown files. Unlike `mdast-util-toc`, which works with MDAST, `markdown-toc` operates directly on Markdown strings, making it simpler to use for straightforward TOC generation without needing to parse the Markdown into an abstract syntax tree.
The `markdown-it-toc-done-right` package is a plugin for the `markdown-it` Markdown parser that generates a Table of Contents. It is similar to `mdast-util-toc` in functionality but is designed to work within the `markdown-it` ecosystem, providing seamless integration if you are using `markdown-it` for Markdown processing.
mdast utility to generate a table of contents.
This package is a utility that generates a table of contents from a document.
This utility is useful to generate a section so users can more easily navigate through a document.
This package is wrapped in remark-toc for ease of use with
remark, where it also injects the table of contents into the document.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-toc
In Deno with esm.sh:
import {toc} from 'https://esm.sh/mdast-util-toc@7'
In browsers with esm.sh:
<script type="module">
import {toc} from 'https://esm.sh/mdast-util-toc@7?bundle'
</script>
import {toc} from 'mdast-util-toc'
/** @type {import('mdast').Root} */
const tree = {
type: 'root',
children: [
{type: 'heading', depth: 1, children: [{type: 'text', value: 'Alpha'}]},
{type: 'heading', depth: 2, children: [{type: 'text', value: 'Bravo'}]},
{type: 'heading', depth: 3, children: [{type: 'text', value: 'Charlie'}]},
{type: 'heading', depth: 2, children: [{type: 'text', value: 'Delta'}]}
]
}
const table = toc(tree)
console.dir(table, {depth: 3})
Yields:
{
index: undefined,
endIndex: undefined,
map: {
type: 'list',
ordered: false,
spread: true,
children: [ { type: 'listItem', spread: true, children: [Array] } ]
}
}
This package exports the identifier toc.
There is no default export.
toc(tree[, options])Generate a table of contents from tree.
Looks for the first heading matching options.heading (case insensitive) and
returns a table of contents (a list) for all following headings.
If no heading is specified, creates a table of contents for all headings in
tree.
tree is not changed.
Links in the list to headings are based on GitHub’s style.
Only top-level headings (those not in blockquotes or lists), are used.
This default behavior can be changed by passing options.parents.
Results (Result).
OptionsConfiguration (TypeScript type).
heading (string, optional)
— heading to look for, wrapped in new RegExp('^(' + value + ')$', 'i')maxDepth (number, default: 6)
— maximum heading depth to include in the table of contents.
This is inclusive: when set to 3, level three headings are included
(those with three hashes, ###)minDepth (number, default: 1)
— minimum heading depth to include in the table of contents.
This is inclusive: when set to 3, level three headings are included
(those with three hashes, ###)skip (string, optional)
— headings to skip, wrapped in new RegExp('^(' + value + ')$', 'i').
Any heading matching this expression will not be present in the table of
contentsparents (Test, default: tree)
— allow headings to be children of certain node types.
Can by any unist-util-is compatible testtight (boolean, default: false)
— whether to compile list items tightlyordered (boolean, default: false)
— whether to compile list items as an ordered list, otherwise they are
unorderedprefix (string, optional)
— add a prefix to links to headings in the table of contents.
Useful for example when later going from mdast to hast and sanitizing with
hast-util-sanitize.ResultResults (TypeScript type).
index (number or undefined)
— index of the node right after the table of contents heading, -1 if no
heading was found, undefined if no heading was givenendIndex (number or undefined)
— index of the first node after heading that is not part of its section,
-1 if no heading was found, undefined if no heading was given, same as
index if there are no nodes between heading and the first heading in
the table of contentsmap (List or undefined)
— list representing the generated table of contents, undefined if no
table of contents could be created, either because no heading was found or
because no following headings were foundThis package is fully typed with TypeScript.
It exports the types Options and Result.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, mdast-util-toc@^7,
compatible with Node.js 16.
Use of mdast-util-toc does not involve hast, user content, or change the
tree, so there are no openings for cross-site scripting (XSS) attacks.
Injecting map into the syntax tree may open you up to XSS attacks as existing
nodes are copied into the table of contents.
The following example shows how an existing script is copied into the table of
contents.
For the following Markdown:
# Alpha
## Bravo<script>alert(1)</script>
## Charlie
Yields in map:
- [Alpha](#alpha)
- [Bravo<script>alert(1)</script>](#bravoscriptalert1script)
- [Charlie](#charlie)
Always use hast-util-santize when transforming to hast.
github-slugger
— generate a slug just like GitHub doesunist-util-visit
— visit nodesunist-util-visit-parents
— like visit, but with a stack of parentsSee contributing.md in syntax-tree/.github for
ways to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
mdast utility to generate a table of contents from a tree
We found that mdast-util-toc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.