markmv - v1.41.7
    Preparing search index...

    Interface IndexCliOptions

    Raw CLI options accepted by indexCommand, before defaults are applied.

    interface IndexCliOptions {
        boundary?: string;
        dryRun?: boolean;
        embedStyle?: "markdown" | "obsidian";
        generateToc?: boolean;
        json?: boolean;
        location?: "root" | "all" | "branch" | "existing";
        maxDepth?: number;
        name?: string;
        noTraverseUp?: boolean;
        strategy?: "manual" | "directory" | "metadata";
        template?: string;
        tocIncludeLineNumbers?: boolean;
        tocMaxDepth?: number;
        tocMinDepth?: number;
        type?: "links" | "embed" | "import" | "hybrid";
        verbose?: boolean;
    }
    Index
    boundary? dryRun? embedStyle? generateToc? json? location? maxDepth? name? noTraverseUp? strategy? template? tocIncludeLineNumbers? tocMaxDepth? tocMinDepth? type? verbose?
    boundary?: string

    Explicit boundary path to limit scanning scope

    dryRun?: boolean

    Report what would be written without changing any files

    embedStyle?: "markdown" | "obsidian"

    Style for embedded content

    obsidian

    generateToc?: boolean

    Generate a table of contents for each indexed file

    json?: boolean

    Print the result as JSON

    location?: "root" | "all" | "branch" | "existing"

    Where to place generated index files

    root

    maxDepth?: number

    Maximum depth to traverse subdirectories

    name?: string

    Name for generated index files

    index.md

    noTraverseUp?: boolean

    Prevent traversing up from the specified directory

    strategy?: "manual" | "directory" | "metadata"

    Strategy for organising files in the index

    directory

    template?: string

    Path to a custom template file

    tocIncludeLineNumbers?: boolean

    Include line numbers in generated tables of contents

    tocMaxDepth?: number

    Maximum heading depth included in generated tables of contents

    6
    tocMinDepth?: number

    Minimum heading depth included in generated tables of contents

    1
    type?: "links" | "embed" | "import" | "hybrid"

    Type of index content to generate

    links

    verbose?: boolean

    Enable verbose output with detailed progress information

    Settings
    Member Visibility

    On This Page
    Properties