Options

Please view options exposed by typedoc-plugin-markdown in addition to those listed here.

Preset Options

The following are preset typedoc-plugin-markdown options:

{
  "hidePageHeader": true,
  "entryFileName": "index.md",
  "out": "./api"
}

The following options are exposed by this plugin:

💡

The path to the VitePress project root.

Defaults to "./".

If TypeDoc is run from outside of the VitePress project root directory, then docsRoot should be set to the path of the VitePress root directory.

e.g. the following file structure:

  ├── package.json
  ├── typedoc.json
  └── docs/
      └── .vitepress/
      └── typedoc-api/
          └── index.md

Requires the following config:

typedoc.json

{
  "out": "./docs/typedoc-api",
  "docsRoot": "./docs"
}

typedoc.json

{
  "docsRoot": "./"
}

💡

Configures the autogenerated VitePress sidebar.

Accepts a key/value object.

sidebar.autoConfiguration

Set to false to disable sidebar generation. Defaults to true.

sidebar.format

Enables backward compatibility with VuePress. Available options ["vitepress", "vuepress1", "vuepress2"]. Defaults to "vitepress".

sidebar.collapsed

Determines if sidebar items with children are open or closed. Set collapsed to false to set sidebar items as open by default.

sidebar.pretty

Pretty format the sidebar JSON.

typedoc.json

{
  "sidebar": {
    "autoConfiguration": true,
    "format": "vitepress",
    "pretty": false,
    "collapsed": true
  }
}