vitepress-plugin-analyzer

vitepress-plugin-analyzer

A build-time Markdown analyzer that scans the docs directory, resolves page links, and exposes site metadata through a Vite virtual module consumed by the theme.

Installation

npm install vitepress-plugin-analyzer

Usage

// .vitepress/config.ts
import { vitePressAnalyzerPlugin } from 'vitepress-plugin-analyzer'

export default {
  vite: {
    plugins: [vitePressAnalyzerPlugin()]
  }
}

Configuration

All options are optional with sensible defaults:

vitePressAnalyzerPlugin({
  docsDir: 'docs',                          // root directory for markdown files
  excludeDirs: ['node_modules', '.git'],    // directories to skip
  includeFiles: ['.md'],                    // file extensions to process
  excludeFiles: [],                         // specific files to skip
  ignoreCase: true,                         // case-insensitive link matching
  resolutionModes: ['repoRoot', 'absolutePath', 'relativeToCurrentFile'],
  logLevel: 'warn'                          // silent | error | warn | info | debug
})

Set VITEPRESS_ANALYZER_LOG_LEVEL (or ANALYZER_LOG_LEVEL) to override the default log level at runtime.

How It Works

The theme imports the virtual module to render backlinks, tag pages, and site graphs.

License

MIT