markmv - v1.41.7
    Preparing search index...

    Interface TocCliOptions

    CLI-specific options for the toc command.

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

    Hierarchy

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

    Show what would be changed without making changes

    force?: boolean

    Force operation even if conflicts exist

    headingLevel: number

    TOC heading level (1-6)

    2
    includeLineNumbers: boolean

    Include line numbers in TOC entries

    json?: boolean

    Output results in JSON format

    marker?: string

    Custom marker to find existing TOC for replacement

    maxDepth: number

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

    minDepth: number

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

    position?: string

    Position where to insert TOC

    skipEmpty: boolean

    Skip files that don't have any headings

    title: string

    Custom TOC title

    "Table of Contents"
    verbose?: boolean

    Show detailed output

    Settings
    Member Visibility

    On This Page
    Properties