markmv - v1.39.2
    Preparing search index...

    Function treeCommand

    • CLI command handler that renders the markdown tree under a path with documentation statistics.

      The scan is read-only, so there is no dry-run mode. Rendering is deterministic: directories before files, each group alphabetically, node_modules/.git/dist excluded. Word counts follow the countWords rule: whitespace-separated tokens outside fenced code blocks and inline code spans. Internal links are checked for file existence only (no network).

      Parameters

      • targetPath: string | undefined

        Directory or markdown file to scan (defaults to the current directory)

      • options: TreeCliOptions

        CLI options

      Returns Promise<void>

      - markmv tree
      - markmv tree docs/ --max-depth 2
      - markmv tree docs/ --format json