markmv - v1.29.0
    Preparing search index...

    Interface TocOperationOptions

    Configuration options for TOC generation operations.

    Controls how table of contents is generated and inserted into markdown files.

    interface TocOperationOptions {
        minDepth: number;
        maxDepth: number;
        includeLineNumbers: boolean;
        position: "replace" | "top" | "after-title" | "before-content";
        title: string;
        headingLevel: number;
        marker?: string;
        skipEmpty: boolean;
        dryRun?: boolean;
        verbose?: boolean;
        force?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    minDepth maxDepth includeLineNumbers position title headingLevel marker? skipEmpty 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

    position: "replace" | "top" | "after-title" | "before-content"

    Position where to insert TOC: 'top' | 'after-title' | 'before-content' | 'replace'

    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

    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