search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
702 stars 176 forks source link

Export Docusaurus plugin options type #440

Closed PatrikTrefil closed 4 months ago

PatrikTrefil commented 1 year ago

Could you also export the type of the plugin options of Docusaurus so it could be used with JSDoc like this?

/** @type {import('@docusaurus/types').Config} */
const config = {
    plugins: [
        [
            "docusaurus-plugin-typedoc",
            /** @type {import("docusaurus-plugin-typedoc").PluginOptions} */
            {
                entryPoints: [`...`],
                tsconfig: `...`,
                ...
            }
        ]
    ]
    ...
}
tgreyuk commented 1 year ago

Types are exposed in 'next' version. If strongly type checking is required I think something like this would be required:

/** @type {Partial<import("typedoc").TypeDocOptions> & Partial<import("docusaurus-plugin-typedoc").PluginOptions>} */
tgreyuk commented 4 months ago

docusaurus-plugin-typedoc@1.0.0