Class TocGenerator

Utility for generating table of contents from markdown content.

This class extracts headings from markdown content and generates formatted table of contents with proper indentation and anchor links.

Example

Basic usage

const generator = new TocGenerator();
const content = `# Title\n## Section 1\n### Subsection\n## Section 2`;
const result = await generator.generateToc(content);

console.log(result.toc);
// Output:
// - [Title](#title)
//   - [Section 1](#section-1)
//     - [Subsection](#subsection)
//   - [Section 2](#section-2)

Example

With custom options

const generator = new TocGenerator();
const options = {
minDepth: 2,
maxDepth: 4,
includeLineNumbers: true
};
const result = await generator.generateToc(content, options);

Index

Constructors

constructor

Methods

generateToc extractHeadings

Constructors

constructor

new TocGenerator(): TocGenerator
Returns TocGenerator

Methods

generateToc

generateToc(content: string, options?: TocOptions): Promise<TocGeneratorResult>
Generate table of contents from markdown content.
Parameters
- content: string
  Markdown content to analyze
- options: TocOptions = {}
  Configuration options
Returns Promise<TocGeneratorResult>
Promise resolving to TOC result
- Defined in utils/toc-generator.ts:102

extractHeadings

extractHeadings(
content: string,
options?: TocOptions,
): Promise<MarkdownHeading[]>
Extract headings from markdown content without generating TOC.
Parameters
- content: string
  Markdown content to analyze
- options: TocOptions = {}
  Configuration options
Returns Promise<MarkdownHeading[]>
Promise resolving to array of headings
- Defined in utils/toc-generator.ts:149

Class TocGenerator

Example

Example

Index

Constructors

Methods

Constructors

constructor

Returns TocGenerator

Methods

generateToc

Parameters

Returns Promise<TocGeneratorResult>

extractHeadings

Parameters

Returns Promise<MarkdownHeading[]>

Settings

On This Page