Plugin 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"
}

Plugin Options

The following options are exposed by this plugin:

sidebar

💡

Configures the autogenerated Docusaurus sidebar.

Accepts a key/value object.

autoConfiguration

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

typescript

Set to true to generate a TypeScript file. Defaults to false (CommonJs).

pretty

Pretty format the sidebar JSON. Defaults to false.

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.

docusaurus.config.js


{
  plugins: [
    [
      'docusaurus-plugin-typedoc',
      {
        sidebar: {
          autoConfiguration: true,
          pretty: false,
          typescript: false,
          deprecatedItemClassName: 'typedoc-sidebar-item-deprecated',
        },
      },
    ],
  ];
}