markmv - v1.29.0
    Preparing search index...

    Interface TocCliOptions

    CLI-specific options for the toc command.

    interface TocCliOptions {
        minDepth: number;
        maxDepth: number;
        includeLineNumbers: boolean;
        title: string;
        headingLevel: number;
        marker?: string;
        skipEmpty: boolean;
        position?: string;
        json?: boolean;
        dryRun?: boolean;
        verbose?: boolean;
        force?: boolean;
    }

    Hierarchy

    Index

    Properties

    minDepth maxDepth includeLineNumbers title headingLevel marker? skipEmpty position? json? dryRun? verbose? force?

    Properties

    minDepth: number

    Minimum heading level to include in TOC (1-6)

    maxDepth: number

    Maximum heading level to include in TOC (1-6)

    includeLineNumbers: boolean

    Include line numbers in TOC entries

    title: string

    Custom TOC title (default: "Table of Contents")

    headingLevel: number

    TOC heading level (1-6, default: 2)

    marker?: string

    Custom marker to find existing TOC for replacement

    skipEmpty: boolean

    Skip files that don't have any headings

    position?: string

    Position where to insert TOC

    json?: boolean

    Output results in JSON format

    dryRun?: boolean

    Show what would be changed without making changes

    verbose?: boolean

    Show detailed output

    force?: boolean

    Force operation even if conflicts exist

    Settings

    Member Visibility

    On This Page

    Properties