typedoc-vitepress-theme

Overview

typedoc-vitepress-theme applies VitePress-friendly Markdown defaults and emits the sidebar data needed to wire the generated docs into a VitePress site.

Use it when TypeDoc runs outside VitePress itself but the output still needs to slot cleanly into the VitePress navigation and link model.

Features

• Updates internal anchors to be compatible with VitePress.
• Auto generates a VitePress sidebar that can be referenced from the VitePress config.

What about VuePress?

This theme is also compatible with VuePress and the configuration is almost identical. However this theme supersedes previous VuePress TypeDoc plugins and is specifically targetted for VitePress.

See https://vitepress.dev/guide/what-is-vitepress#what-about-vuepress .

Example

The following is a simple example of a VitePress project running TypeDoc.