Option Typings

You can inform your IDE about the shape of the exported options the plugin provides.

JSON Files

You can utilize the provided JSON schema at https://typedoc-plugin-markdown.org/schema.json . For simplicity of configuration, this schema consolidates all options from TypeDoc and the plugin.

typedoc.json


{
  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
  "entryPoints": ["./src/index.ts", "./src/secondary-entry.ts"],
  "out": "docs",
  "plugin": ["typedoc-plugin-markdown", "some-other-plugin"],
};

JavaScript Files

For JavaScript files, the PluginOptions interface can be imported to a typedoc.config.js file with a @type annotation.

You can use intersection types to combine the TypeDoc options with the plugin options.

typedoc.config.cjs


// @ts-check
 
/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */
module.exports = {
  entryPoints: ['./src/index.ts', './src/secondary-entry.ts'],
  out: 'doc',
  plugin: ['typedoc-plugin-markdown', 'some-other-plugin'],
};