typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Export Docusaurus plugin options type

Open PatrikTrefil opened this issue 2 years ago • 1 comments
trafficstars

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: `...`,
                ...
            }
        ]
    ]
    ...
}

PatrikTrefil avatar May 26 '23 12:05 PatrikTrefil

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 avatar Jun 12 '23 21:06 tgreyuk

[email protected]

tgreyuk avatar May 04 '24 12:05 tgreyuk