fw-vitepress

To generate VitePress documentation templates, this adapter parses your project's navigation structures and maps source code to documentation pages. It detects typical configuration locations like .vitepress/config.ts to produce consistent API references and guides.

VitePress sidebar configuration parsing works by reading themeConfig.sidebar and themeConfig.nav to derive documentation structure. The adapter uses these navigation mappings to automatically organize API references and guides within your project.

You can use this adapter with an existing .vitepress/config.mts file, as it detects common VitePress project patterns including config.ts, config.js, and config.mts. It requires these typical configuration locations to map source code correctly.

The best way to map Vue components to VitePress documentation pages is using an adapter that detects components and applies mapping rules. This approach generates consistent documentation templates and ensures your API references match your source code structure.

VitePress nav generation may not match your source code if the configuration file is not located at .vitepress/config.ts or similar supported paths. Accurate mapping requires the adapter to successfully detect and parse these typical config locations.