TocOptions

import { TocOptions } from "jsr:@ende/markdown";

interface

interface TocOptions

Options for toc().

Example: Usage

import type { TocOptions } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

const options: TocOptions = { minDepth: 2, maxDepth: 3 };
assertEquals(options.maxDepth, 3);

Properties

`minDepth`

minDepth?: number

The shallowest heading level to include.

Default: 1

`maxDepth`

maxDepth?: number

The deepest heading level to include.

Default: 6

Source