This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy under /_llms/. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Skip to main content Skip to navigation

MarkdownOutlineGenerator Pennington.Markdown

Extracts heading outline from a parsed Markdown document.

Methods

GenerateOutline

#
public static OutlineEntry[] GenerateOutline(MarkdownDocument document)

Produces outline entries for every heading in the document that has an id attribute.

Parameters

document MarkdownDocument

Returns

OutlineEntry[]

Pennington.Markdown.MarkdownOutlineGenerator

namespace Pennington.Markdown;

/// Extracts heading outline from a parsed Markdown document.
public class MarkdownOutlineGenerator
{
    /// Produces outline entries for every heading in the document that has an id attribute.
    
public static OutlineEntry[] GenerateOutline(MarkdownDocument document)

;
}