markmv - v1.26.2
    Preparing search index...

    Interface IndexOptions

    Configuration options for index generation operations.

    Controls how documentation indexes are created, including content type, organization strategy, and output locations.

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

    Properties

    type strategy location name embedStyle template? dryRun verbose maxDepth? noTraverseUp boundary?

    Properties

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

    Type of index content to generate

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

    Strategy for organizing files in the index

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

    Where to place generated index files

    name: string

    Name for generated index files

    embedStyle: "markdown" | "obsidian"

    Style for embedded content (Obsidian or standard markdown)

    template?: string

    Path to custom template file

    dryRun: boolean

    Perform a dry run without making actual changes

    verbose: boolean

    Enable verbose output with detailed progress information

    maxDepth?: number

    Maximum depth to traverse subdirectories

    noTraverseUp: boolean

    Prevent traversing up from the specified directory

    boundary?: string

    Explicit boundary path to limit scanning scope

    Settings

    Member Visibility

    On This Page

    Properties