typedoc-vitepress-theme

Overview

This plugin generates Markdown tailored to VitePress.

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.