Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 1.44 KB

vitepress.mdx

File metadata and controls

43 lines (33 loc) · 1.44 KB
Raw

import Image from 'next/image'; import pjson from '../../../packages/typedoc-vitepress-theme/package.json'; import { Callout, Steps } from 'nextra/components'; import { Cards } from 'nextra/components'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import { faGithub } from '@fortawesome/free-brands-svg-icons'; import { faBolt } from '@fortawesome/free-solid-svg-icons';

typedoc-vitepress-theme

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.

} arrow={true} href="https://github.com/typedoc-plugin-markdown/typedoc-vitepress-theme-example" target="_blank" /> } arrow={true} href="https://stackblitz.com/~/github.com/typedoc-plugin-markdown/typedoc-vitepress-theme-example" target="_blank" />