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:

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

The following options are exposed by this plugin:

💡

Configures the autogenerated Docusaurus sidebar.

Accepts a key/value object.

autoConfiguration

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

pretty

Pretty format the sidebar JSON.

deprecatedItemClassName

The class name to apply to deprecated items in the sidebar. Defaults to "typedoc-sidebar-item-deprecated".

Please see the sidebar guide for additional information on sidebar setup.

typedoc.json

{
  "sidebar": {
    "autoConfiguration": true,
    "pretty": false,
    "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
  }
}