7.1.0 • Published 2 years ago

mdast-util-toc

Licence

MIT

Version

7.1.0

Deps

Size

31 kB

Vulns

Weekly

Stars

Summary Dependency Versions

mdast-util-toc

mdast utility to generate a table of contents.

What is this?
When should I use this?
Install
Use
API
Types
Compatibility
Security
Related
Contribute
License

What is this?

This package is a utility that generates a table of contents from a document.

When should I use this?

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.

Install

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>

Use

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] } ]
  }
}

API

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.

Parameters

tree (Node) — tree to search and generate from
options (Options, optional) — configuration

Returns

Results (Result).

`Options`

Configuration (TypeScript type).

Fields

heading (string, optional) — heading to look for, wrapped in new RegExp('^(' + value + ')


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 + ').
Any heading matching this expression will not be present in the table of
contents

parents (Test, default: tree)
— allow headings to be children of certain node types.
Can by any unist-util-is compatible test
tight (boolean, default: false)
— whether to compile list items tightly
ordered (boolean, default: false)
— whether to compile list items as an ordered list, otherwise they are
unordered
prefix (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.


Result
Results (TypeScript type).
Fields

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 given
endIndex (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 contents
map (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 found

Types
This package is fully typed with TypeScript.
It exports the types Options and Result.
Compatibility
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.
Security
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.
Related

github-slugger
— generate a slug just like GitHub does
unist-util-visit
— visit nodes
unist-util-visit-parents
— like visit, but with a stack of parents

Contribute
See 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.
License
MIT  Jonathan Haines
, 'i')
__INLINE_CODE_23__ (__INLINE_CODE_24__, default: __INLINE_CODE_25__)
— maximum heading depth to include in the table of contents.
This is inclusive: when set to __INLINE_CODE_26__, level three headings are included
(those with three hashes, __INLINE_CODE_27__)
__INLINE_CODE_28__ (__INLINE_CODE_29__, default: __INLINE_CODE_30__)
— minimum heading depth to include in the table of contents.
This is inclusive: when set to __INLINE_CODE_31__, level three headings are included
(those with three hashes, __INLINE_CODE_32__)
__INLINE_CODE_33__ (__INLINE_CODE_34__, optional)
— headings to skip, wrapped in __INLINE_CODE_35__.
Any heading matching this expression will not be present in the table of
contents
__INLINE_CODE_36__ (__INLINE_CODE_37__, default: __INLINE_CODE_38__)
— allow headings to be children of certain node types.
Can by any __INLINE_CODE_39__ compatible test
__INLINE_CODE_40__ (__INLINE_CODE_41__, default: __INLINE_CODE_42__)
— whether to compile list items tightly
__INLINE_CODE_43__ (__INLINE_CODE_44__, default: __INLINE_CODE_45__)
— whether to compile list items as an ordered list, otherwise they are
unordered
__INLINE_CODE_46__ (__INLINE_CODE_47__, 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
__INLINE_CODE_48__.

__INLINE_CODE_49__
Results (TypeScript type).
Fields

__INLINE_CODE_50__ (__INLINE_CODE_51__ or __INLINE_CODE_52__)
— index of the node right after the table of contents heading, __INLINE_CODE_53__ if no
heading was found, __INLINE_CODE_54__ if no __INLINE_CODE_55__ was given
__INLINE_CODE_56__ (__INLINE_CODE_57__ or __INLINE_CODE_58__)
— index of the first node after __INLINE_CODE_59__ that is not part of its section,
__INLINE_CODE_60__ if no heading was found, __INLINE_CODE_61__ if no __INLINE_CODE_62__ was given, same as
__INLINE_CODE_63__ if there are no nodes between __INLINE_CODE_64__ and the first heading in
the table of contents
__INLINE_CODE_65__ (__INLINE_CODE_66__ or __INLINE_CODE_67__)
— list representing the generated table of contents, __INLINE_CODE_68__ if no
table of contents could be created, either because no heading was found or
because no following headings were found

Types
This package is fully typed with TypeScript.
It exports the types __INLINE_CODE_69__ and __INLINE_CODE_70__.
Compatibility
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, __INLINE_CODE_71__,
compatible with Node.js 16.
Security
Use of __INLINE_CODE_72__ does not involve hast, user content, or change the
tree, so there are no openings for cross-site scripting (XSS) attacks.
Injecting __INLINE_CODE_73__ 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 __INLINE_CODE_74__:
-   [Alpha](#alpha)

    -   [Bravo<script>alert(1)</script>](#bravoscriptalert1script)
    -   [Charlie](#charlie)
Always use __INLINE_CODE_75__ when transforming to hast.
Related

__INLINE_CODE_76__
— generate a slug just like GitHub does
__INLINE_CODE_77__
— visit nodes
__INLINE_CODE_78__
— like __INLINE_CODE_79__, but with a stack of parents

Contribute
See __INLINE_CODE_80__ in __INLINE_CODE_81__ for
ways to get started.
See __INLINE_CODE_82__ 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.
License
MIT  Jonathan Haines
, 'i')

. Any heading matching this expression will not be present in the table of contents

__INLINE_CODE_36__ (__INLINE_CODE_37__, default: __INLINE_CODE_38__) — allow headings to be children of certain node types. Can by any __INLINE_CODE_39__ compatible test

__INLINE_CODE_40__ (__INLINE_CODE_41__, default: __INLINE_CODE_42__) — whether to compile list items tightly

__INLINE_CODE_43__ (__INLINE_CODE_44__, default: __INLINE_CODE_45__) — whether to compile list items as an ordered list, otherwise they are unordered

__INLINE_CODE_46__ (__INLINE_CODE_47__, 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 __INLINE_CODE_48__.

__INLINE_CODE_49__

Results (TypeScript type).

Fields

__INLINE_CODE_50__ (__INLINE_CODE_51__ or __INLINE_CODE_52__) — index of the node right after the table of contents heading, __INLINE_CODE_53__ if no heading was found, __INLINE_CODE_54__ if no __INLINE_CODE_55__ was given
__INLINE_CODE_56__ (__INLINE_CODE_57__ or __INLINE_CODE_58__) — index of the first node after __INLINE_CODE_59__ that is not part of its section, __INLINE_CODE_60__ if no heading was found, __INLINE_CODE_61__ if no __INLINE_CODE_62__ was given, same as __INLINE_CODE_63__ if there are no nodes between __INLINE_CODE_64__ and the first heading in the table of contents
__INLINE_CODE_65__ (__INLINE_CODE_66__ or __INLINE_CODE_67__) — list representing the generated table of contents, __INLINE_CODE_68__ if no table of contents could be created, either because no heading was found or because no following headings were found

Types

This package is fully typed with TypeScript. It exports the types __INLINE_CODE_69__ and __INLINE_CODE_70__.

Compatibility

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, __INLINE_CODE_71__, compatible with Node.js 16.

Security

Use of __INLINE_CODE_72__ does not involve hast, user content, or change the tree, so there are no openings for cross-site scripting (XSS) attacks.

Injecting __INLINE_CODE_73__ 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 __INLINE_CODE_74__:

-   [Alpha](#alpha)

    -   [Bravo<script>alert(1)</script>](#bravoscriptalert1script)
    -   [Charlie](#charlie)

Always use __INLINE_CODE_75__ when transforming to hast.

__INLINE_CODE_76__ — generate a slug just like GitHub does
__INLINE_CODE_77__ — visit nodes
__INLINE_CODE_78__ — like __INLINE_CODE_79__, but with a stack of parents

Contribute

See __INLINE_CODE_80__ in __INLINE_CODE_81__ for ways to get started. See __INLINE_CODE_82__ 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.

License

MIT Jonathan Haines

, 'i')

__INLINE_CODE_23__ (__INLINE_CODE_24__, default: __INLINE_CODE_25__) — maximum heading depth to include in the table of contents. This is inclusive: when set to __INLINE_CODE_26__, level three headings are included (those with three hashes, __INLINE_CODE_27__)

__INLINE_CODE_28__ (__INLINE_CODE_29__, default: __INLINE_CODE_30__) — minimum heading depth to include in the table of contents. This is inclusive: when set to __INLINE_CODE_31__, level three headings are included (those with three hashes, __INLINE_CODE_32__)

__INLINE_CODE_33__ (__INLINE_CODE_34__, optional) — headings to skip, wrapped in __INLINE_CODE_35__. Any heading matching this expression will not be present in the table of contents

__INLINE_CODE_36__ (__INLINE_CODE_37__, default: __INLINE_CODE_38__) — allow headings to be children of certain node types. Can by any __INLINE_CODE_39__ compatible test

__INLINE_CODE_40__ (__INLINE_CODE_41__, default: __INLINE_CODE_42__) — whether to compile list items tightly

__INLINE_CODE_43__ (__INLINE_CODE_44__, default: __INLINE_CODE_45__) — whether to compile list items as an ordered list, otherwise they are unordered

__INLINE_CODE_49__

Results (TypeScript type).

Fields

__INLINE_CODE_50__ (__INLINE_CODE_51__ or __INLINE_CODE_52__) — index of the node right after the table of contents heading, __INLINE_CODE_53__ if no heading was found, __INLINE_CODE_54__ if no __INLINE_CODE_55__ was given
__INLINE_CODE_56__ (__INLINE_CODE_57__ or __INLINE_CODE_58__) — index of the first node after __INLINE_CODE_59__ that is not part of its section, __INLINE_CODE_60__ if no heading was found, __INLINE_CODE_61__ if no __INLINE_CODE_62__ was given, same as __INLINE_CODE_63__ if there are no nodes between __INLINE_CODE_64__ and the first heading in the table of contents
__INLINE_CODE_65__ (__INLINE_CODE_66__ or __INLINE_CODE_67__) — list representing the generated table of contents, __INLINE_CODE_68__ if no table of contents could be created, either because no heading was found or because no following headings were found

# Alpha

## Bravo<script>alert(1)</script>

## Charlie

Yields in __INLINE_CODE_74__:

-   [Alpha](#alpha)

    -   [Bravo<script>alert(1)</script>](#bravoscriptalert1script)
    -   [Charlie](#charlie)

Always use __INLINE_CODE_75__ when transforming to hast.

__INLINE_CODE_76__ — generate a slug just like GitHub does
__INLINE_CODE_77__ — visit nodes
__INLINE_CODE_78__ — like __INLINE_CODE_79__, but with a stack of parents