Plugin Options

Preset Options

The following are preset typedoc-plugin-markdown options:

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

Plugin Options

The following options are exposed by this plugin:

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.

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

docsPath

Defaults to "./docs".

Path to the docs content directory on the file system, relative to the Docusaurus site directory.

This should match the docs.path value configured in the docusaurus.config.js docs preset.

Note: docusaurus-plugin-typedoc will automatically attempt to set this option based on your Docusaurus configuration.

{
  "docsPath": "./docs"
}

numberPrefixParser

Accepts a boolean value. Defaults to true.

By default, Docusaurus applies custom parsing logic to extract number prefixes from file names.

You can disable this behavior by setting numberPrefixParser: false in the docs preset of your docusaurus.config.js file. This option should match the value configured there.

Note: docusaurus-plugin-typedoc will automatically attempt to set this option based on your Docusaurus configuration.

{
  "numberPrefixParser": false
}