markmv - v1.26.2
    Preparing search index...

    Function indexCommand

    • CLI command handler for generating documentation indexes.

      Creates organized documentation indexes from markdown files using various strategies. Supports multiple index types including links, imports, embeds, and hybrid modes.

      Parameters

      • directory: undefined | string

        Target directory for index generation

      • cliOptions: IndexCliOptions

        Command options specifying index parameters

      Returns Promise<void>

        # Generate a links-based index
      markmv index --type links --strategy directory

      # Generate with custom template
      markmv index docs/ --type hybrid --template custom.md

      # Dry run with verbose output
      markmv index --dry-run --verbose