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:

{
  "entryFileName": "Home.md",
  "hidePageHeader": true,
  "flattenOutputFiles": true
}

The following options are exposed by this plugin:

💡

Configures the autogenerated _sidebar.md file.

Accepts a key/value object.

sidebar.autoConfiguration

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

sidebar.heading

The heading displayed above the sidebar.

typedoc.json

{
  "sidebar": {
    "autoConfiguration": true,
    "heading": "API"
  }
}