diff --git a/.changeset/two-meals-fix.md b/.changeset/two-meals-fix.md new file mode 100644 index 000000000..bb1c0d464 --- /dev/null +++ b/.changeset/two-meals-fix.md @@ -0,0 +1,7 @@ +--- +"typedoc-plugin-markdown": patch +--- + +- Fix params being incorrectly escaped in list format. +- Removed generator in footer. +- Fix typing of the defineTheme method. diff --git a/docs/pages/options.mdx b/docs/pages/options.mdx index 71077cede..ea0fd3ebf 100644 --- a/docs/pages/options.mdx +++ b/docs/pages/options.mdx @@ -422,7 +422,6 @@ Below is the full list of keys and default values: "header.readme": "Readme", "header.docs": "API", "breadcrumbs.home": "{projectName} {version}", - "footer.generator": "Generated using TypeDoc and typedoc-plugin-markdown.", "title.indexPage": "{projectName} {version}", "title.modulePage": "{name}", "title.memberPage": "{kind}: {name}", diff --git a/docs/pages/quick-start.mdx b/docs/pages/quick-start.mdx index f4f8a8e25..f14467e7c 100644 --- a/docs/pages/quick-start.mdx +++ b/docs/pages/quick-start.mdx @@ -31,6 +31,5 @@ The majority of [TypeDoc's options](https://typedoc.org/options/) are supported, Some typical (and frequently asked about) TypeDoc options that might be useful are: -- Using [hideGenerator](https://typedoc.org/options/output/#hidegenerator) to prevent outputting links in the footer. - Using [disableSources](https://typedoc.org/options/output/#disablesources) to prevent outputting source references. - Setting [readme](https://typedoc.org/options/input/#readme) to `none` to exclude the project readme from the docs. diff --git a/packages/docusaurus-plugin-typedoc/docusaurus.config.js b/packages/docusaurus-plugin-typedoc/docusaurus.config.js index 603c6a62d..600ffc196 100644 --- a/packages/docusaurus-plugin-typedoc/docusaurus.config.js +++ b/packages/docusaurus-plugin-typedoc/docusaurus.config.js @@ -17,7 +17,6 @@ const config = { entryPoints: './test/stubs/src/*', out: './test/out/default', readme: 'none', - hideGenerator: true, cleanOutputDir: true, }, ], @@ -29,7 +28,6 @@ const config = { entryPoints: './test/stubs/src/module-1.ts', out: './test/out/global-members', readme: 'none', - hideGenerator: true, sidebar: { pretty: true }, }, ], diff --git a/packages/typedoc-github-wiki-theme/test/typedoc.base.json b/packages/typedoc-github-wiki-theme/test/typedoc.base.json index f56d3eaae..74ab31486 100644 --- a/packages/typedoc-github-wiki-theme/test/typedoc.base.json +++ b/packages/typedoc-github-wiki-theme/test/typedoc.base.json @@ -6,6 +6,5 @@ "readme": "none", "disableSources": true, "cleanOutputDir": true, - "hideGenerator": true, "logLevel": "Warn" } diff --git a/packages/typedoc-gitlab-wiki-theme/test/typedoc.base.json b/packages/typedoc-gitlab-wiki-theme/test/typedoc.base.json index 87c25d330..baf28512b 100644 --- a/packages/typedoc-gitlab-wiki-theme/test/typedoc.base.json +++ b/packages/typedoc-gitlab-wiki-theme/test/typedoc.base.json @@ -5,6 +5,5 @@ "plugin": ["typedoc-plugin-markdown", "typedoc-gitlab-wiki-theme"], "readme": "none", "disableSources": true, - "cleanOutputDir": true, - "hideGenerator": true + "cleanOutputDir": true } diff --git a/packages/typedoc-plugin-frontmatter/test/typedoc-base.json b/packages/typedoc-plugin-frontmatter/test/typedoc-base.json index 51f389705..d2f6af93f 100644 --- a/packages/typedoc-plugin-frontmatter/test/typedoc-base.json +++ b/packages/typedoc-plugin-frontmatter/test/typedoc-base.json @@ -5,6 +5,5 @@ "readme": "none", "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"], "hidePageHeader": true, - "hideBreadcrumbs": true, - "hideGenerator": true + "hideBreadcrumbs": true } diff --git a/packages/typedoc-plugin-markdown/src/plugin/options/option-types.ts b/packages/typedoc-plugin-markdown/src/plugin/options/option-types.ts index efb62ef42..ba730510e 100644 --- a/packages/typedoc-plugin-markdown/src/plugin/options/option-types.ts +++ b/packages/typedoc-plugin-markdown/src/plugin/options/option-types.ts @@ -63,7 +63,6 @@ export interface TextContentMappings { 'header.readme': string; 'header.docs': string; 'breadcrumbs.home': string; - 'footer.generator': string; 'title.indexPage': string; 'title.modulePage': string; 'title.memberPage': string; diff --git a/packages/typedoc-plugin-markdown/src/plugin/options/text-mappings/text-mapping-defaults.ts b/packages/typedoc-plugin-markdown/src/plugin/options/text-mappings/text-mapping-defaults.ts index 4d997a71a..c2644f031 100644 --- a/packages/typedoc-plugin-markdown/src/plugin/options/text-mappings/text-mapping-defaults.ts +++ b/packages/typedoc-plugin-markdown/src/plugin/options/text-mappings/text-mapping-defaults.ts @@ -5,7 +5,6 @@ export const TEXT_MAPPING_DEFAULTS = { 'header.readme': 'Readme', 'header.docs': 'API', 'breadcrumbs.home': '{projectName} {version}', - 'footer.generator': 'Generated using TypeDoc and typedoc-plugin-markdown.', 'title.indexPage': '{projectName} {version}', 'title.modulePage': '{name}', 'title.memberPage': '{kind}: {name}', diff --git a/packages/typedoc-plugin-markdown/src/plugin/types.ts b/packages/typedoc-plugin-markdown/src/plugin/types.ts index bc84d61ec..f79bd31d4 100644 --- a/packages/typedoc-plugin-markdown/src/plugin/types.ts +++ b/packages/typedoc-plugin-markdown/src/plugin/types.ts @@ -1,4 +1,4 @@ -import { Application, EventHooks, Options, Renderer } from 'typedoc'; +import { Application, EventHooks, Options, Renderer, Theme } from 'typedoc'; import { MarkdownThemeRenderContext } from '../theme'; import { MarkdownRendererEvent } from './events'; @@ -18,6 +18,10 @@ export interface MarkdownApplication extends Application { * The plugin amends the renderer with additional hooks and options. */ export interface MarkdownRenderer extends Renderer { + defineTheme: ( + name: string, + theme: new (renderer: MarkdownRenderer) => Theme, + ) => void; markdownHooks: EventHooks; packageOptions: Record; preRenderAsyncJobs: Array<(output: MarkdownRendererEvent) => Promise>; diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/index.ts b/packages/typedoc-plugin-markdown/src/theme/resources/index.ts index ee72fd815..f1c4bccab 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/index.ts @@ -12,7 +12,6 @@ import { breadcrumbs, commentParts, comment, - generator, header, pageIndex, reflectionIndex, @@ -93,7 +92,6 @@ export const partials = (context: MarkdownThemeRenderContext) => { breadcrumbs: bind(breadcrumbs, context), commentParts: bind(commentParts, context), comment: bind(comment, context), - generator: bind(generator, context), header: bind(header, context), pageIndex: bind(pageIndex, context), reflectionIndex: bind(reflectionIndex, context), diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/generator.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/generator.ts deleted file mode 100644 index ac6681c02..000000000 --- a/packages/typedoc-plugin-markdown/src/theme/resources/partials/generator.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { MarkdownThemeRenderContext } from '../..'; -import { horizontalRule } from '../markdown'; - -export function generator(context: MarkdownThemeRenderContext): string { - const generatorText = - 'Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org). '; - - return [horizontalRule(), generatorText].join(''); -} diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/index.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/index.ts index 0491569ec..2c2477968 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/partials/index.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/partials/index.ts @@ -1,7 +1,6 @@ export { breadcrumbs } from './breadcrumbs'; export { commentParts } from './comment.parts'; export { comment } from './comment'; -export { generator } from './generator'; export { header } from './header'; export { pageIndex } from './index.page'; export { reflectionIndex } from './index.reflection'; diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/list.parameters.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/list.parameters.ts index 578daa704..9947834a1 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/partials/list.parameters.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/partials/list.parameters.ts @@ -1,6 +1,6 @@ import { ParameterReflection, ReflectionKind } from 'typedoc'; import { MarkdownThemeRenderContext } from '../..'; -import { backTicks } from '../markdown'; +import { backTicks, bold } from '../markdown'; import { escapeChars } from '../utils'; export function parametersList( @@ -53,7 +53,7 @@ export function parametersList( const name = `${escapeChars(parameter.name)}${optional}`; - const identifier: string[] = [backTicks(name)]; + const identifier: string[] = [bold(name)]; if (parameter.type) { identifier.push(': ' + context.partials.someType(parameter.type)); diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/templates/member.ts b/packages/typedoc-plugin-markdown/src/theme/resources/templates/member.ts index 65e1ac20b..821017432 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/templates/member.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/templates/member.ts @@ -27,10 +27,6 @@ export function memberTemplate( md.push(context.partials.member(page.model, 1)); - if (!context.options.getValue('hideGenerator')) { - md.push(context.partials.generator()); - } - md.push(context.hook('page.end').join('\n')); return md.join('\n\n'); diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/templates/project.ts b/packages/typedoc-plugin-markdown/src/theme/resources/templates/project.ts index 22843ab32..ca9122e9d 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/templates/project.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/templates/project.ts @@ -40,10 +40,6 @@ export function projectTemplate( md.push(context.partials.members(page.model, 2)); - if (!context.options.getValue('hideGenerator')) { - md.push(context.partials.generator()); - } - md.push(context.hook('page.end').join('\n')); return md.join('\n\n'); diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/templates/read-me.ts b/packages/typedoc-plugin-markdown/src/theme/resources/templates/read-me.ts index a25fb8ea9..d68c8ce31 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/templates/read-me.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/templates/read-me.ts @@ -22,10 +22,6 @@ export function readmeTemplate( md.push(context.partials.commentParts(page.model.readme)); } - if (!context.options.getValue('hideGenerator')) { - md.push(context.partials.generator()); - } - md.push(context.hook('page.end').join('\n')); return md.join('\n\n'); diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/templates/reflection.ts b/packages/typedoc-plugin-markdown/src/theme/resources/templates/reflection.ts index 2090c4c0e..124ba4a03 100644 --- a/packages/typedoc-plugin-markdown/src/theme/resources/templates/reflection.ts +++ b/packages/typedoc-plugin-markdown/src/theme/resources/templates/reflection.ts @@ -27,10 +27,6 @@ export function reflectionTemplate( md.push(context.partials.reflectionMember(page.model, 2)); - if (!context.options.getValue('hideGenerator')) { - md.push(context.partials.generator()); - } - md.push(context.hook('page.end').join('\n')); return md.join('\n\n'); diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts index 643b3a10a..5adbeb01f 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/config.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/config.ts @@ -7,7 +7,6 @@ const config: Record = { entryPoints: '/reflections/index.ts', commonOptions: { plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')], - hideGenerator: true, hidePageHeader: true, hideBreadcrumbs: true, }, @@ -32,7 +31,6 @@ const config: Record = { commonOptions: { plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')], disableSources: true, - hideGenerator: true, entryFileName: 'index.md', }, options: [ @@ -57,7 +55,6 @@ const config: Record = { disableSources: true, hidePageHeader: true, hideBreadcrumbs: true, - hideGenerator: true, enumMembersFormat: 'table', propertiesFormat: 'table', readme: 'none', @@ -77,7 +74,6 @@ const config: Record = { commonOptions: { plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')], entryPointStrategy: 'packages', - hideGenerator: true, name: 'packages-example', entryFileName: 'index.md', disableSources: true, @@ -92,7 +88,6 @@ const config: Record = { commonOptions: { plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')], entryPointStrategy: 'packages', - hideGenerator: true, name: 'packages-example', includeVersion: true, disableSources: true, @@ -105,7 +100,6 @@ const config: Record = { plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')], entryFileName: 'index.md', entryModule: 'entry-module', - hideGenerator: true, disableSources: true, }, options: [{ entryFileName: 'README.md' }, { readme: 'none' }], @@ -119,7 +113,6 @@ const config: Record = { { entryFileName: 'index.md', disableSources: true, - hideGenerator: true, mergeReadme: true, }, ], @@ -144,7 +137,6 @@ const config: Record = { outputFileStragies: ['members'], commonOptions: { disableSources: true, - hideGenerator: true, readme: 'none', outputFileStrategy: 'modules', }, diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text.cjs index 5f27910aa..dcc051c07 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text.cjs +++ b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text.cjs @@ -6,7 +6,6 @@ module.exports = { 'header.title': 'My API - {version}', 'header.readme': 'My Readme', 'header.docs': 'Docs', - 'footer.generator': '@copyright My Test', 'title.indexPage': ':tada: Custom Index Title', 'title.memberPage': '{name}', 'title.modulePage': '{kind} - {name}', diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap index 437ad8bc0..5d4287aa7 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap @@ -133,7 +133,7 @@ Comments for setter #### Parameters -• \`value\`: \`string\` +• **value**: \`string\` Param comments @@ -153,7 +153,7 @@ Param comments #### Parameters -• \`x\`: \`string\` +• **x**: \`string\` #### Source @@ -277,11 +277,11 @@ Comments for ClassWithConstructorOverloads #### Parameters -• \`x\`: \`number\` +• **x**: \`number\` Comments for x number -• \`y\`: \`string\` +• **y**: \`string\` #### Returns @@ -297,7 +297,7 @@ Comments for x number #### Parameters -• \`x\`: \`string\` +• **x**: \`string\` Comments for x string @@ -315,7 +315,7 @@ Comments for x string #### Parameters -• \`s\`: \`string\` +• **s**: \`string\` #### Returns diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap index 7f7f0a5de..fc71972aa 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap @@ -17,7 +17,7 @@ Comments for function > > ### Parameters > -> • \`x\`: \`string\` +> • **x**: \`string\` > > ### Returns > @@ -185,7 +185,7 @@ This is a function that is assigned to a variable. ## Parameters -• \`someParam\`: \`number\` +• **someParam**: \`number\` This is some numeric parameter. @@ -233,27 +233,27 @@ This is a function with a parameter that has a default value. ## Parameters -• \`valueA\`: \`string\`= \`'defaultValue'\` +• **valueA**: \`string\`= \`'defaultValue'\` A parameter with a default string value. -• \`valueB\`: \`number\`= \`100\` +• **valueB**: \`number\`= \`100\` A parameter with a default numeric value. -• \`valueC\`: \`number\`= \`Number.NaN\` +• **valueC**: \`number\`= \`Number.NaN\` A parameter with a default NaN value. -• \`valueD\`: \`boolean\`= \`true\` +• **valueD**: \`boolean\`= \`true\` A parameter with a default boolean value. -• \`valueE\`: \`boolean\`= \`true\` +• **valueE**: \`boolean\`= \`true\` A parameter with a default null value. -• \`valueF\`: \`string\`= \`''\` +• **valueF**: \`string\`= \`''\` ## Returns @@ -312,7 +312,7 @@ This is the first signature of a function with multiple signatures. ### Parameters -• \`value\`: \`string\` +• **value**: \`string\` The name value. @@ -332,11 +332,11 @@ This is the second signature of a function with multiple signatures. ### Parameters -• \`value\`: \`Object\` +• **value**: \`Object\` An object containing the name value. -• \`value\\.name\`: \`string\` +• **value\\.name**: \`string\` A value of the object. @@ -407,15 +407,15 @@ exports[`Function Reflection should compile function with named params: (Output ## Parameters -• \`\\_\\_namedParameters\`: \`Object\`= \`{}\` +• **\\_\\_namedParameters**: \`Object\`= \`{}\` various options -• \`\\_\\_namedParameters\\.bar?\`: \`number\`= \`43\` +• **\\_\\_namedParameters\\.bar?**: \`number\`= \`43\` -• \`\\_\\_namedParameters\\.foo?\`: \`number\`= \`42\` +• **\\_\\_namedParameters\\.foo?**: \`number\`= \`42\` -• \`anotherParam\`: \`string\` +• **anotherParam**: \`string\` Another param comment @@ -464,29 +464,29 @@ Some nested params. ## Parameters -• \`params\`: \`Object\` +• **params**: \`Object\` The parameters passed to the method. -• \`params\\.name\`: \`string\` +• **params\\.name**: \`string\` The name of the new group. -• \`params\\.nestedObj\`: \`Object\` +• **params\\.nestedObj**: \`Object\` A nested object. -• \`params\\.nestedObj\\.name\`: \`string\` +• **params\\.nestedObj\\.name**: \`string\` -• \`params\\.nestedObj\\.obj\`: \`Object\` +• **params\\.nestedObj\\.obj**: \`Object\` -• \`params\\.nestedObj\\.obj\\.name\`: () => \`void\` +• **params\\.nestedObj\\.obj\\.name**: () => \`void\` -• \`params\\.nestedObj\\.value\`: \`number\` +• **params\\.nestedObj\\.value**: \`number\` -• \`params\\.parent?\`: \`number\` +• **params\\.parent?**: \`number\` -• \`context\`: \`any\` +• **context**: \`any\` The context of the method call. @@ -542,17 +542,17 @@ This is a function with a parameters. ## Parameters -• \`firstParamWithDefault\`: \`boolean\`= \`true\` +• **firstParamWithDefault**: \`boolean\`= \`true\` -• \`requiredParam\`: \`string\` +• **requiredParam**: \`string\` A normal parameter. -• \`optionalParam?\`: \`string\` +• **optionalParam?**: \`string\` An optional parameter. -• \`paramWithDefault?\`: \`number\`= \`0\` +• **paramWithDefault?**: \`number\`= \`0\` ## Returns @@ -573,17 +573,17 @@ This is a function with a parameters. ## Parameters -• \`firstParamWithDefault\`: \`boolean\`= \`true\` +• **firstParamWithDefault**: \`boolean\`= \`true\` -• \`requiredParam\`: \`string\` +• **requiredParam**: \`string\` A normal parameter. -• \`optionalParam?\`: \`string\` +• **optionalParam?**: \`string\` An optional parameter. -• \`paramWithDefault?\`: \`number\`= \`0\` +• **paramWithDefault?**: \`number\`= \`0\` ## Returns diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap index af47fe736..bd7b82798 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap @@ -37,7 +37,7 @@ Comments for functionProper #### Parameters -• \`s\`: \`string\` +• **s**: \`string\` Comment for param s @@ -295,7 +295,7 @@ Comments for functionProper #### Parameters -• \`s\`: \`string\` +• **s**: \`string\` Comment for param s @@ -608,7 +608,7 @@ Description for event someEvent #### Parameters -• \`eventParam\`: [\`CustomEventInterface\`](CustomEventInterface.md)\\<\`MouseEvent\`\\> +• **eventParam**: [\`CustomEventInterface\`](CustomEventInterface.md)\\<\`MouseEvent\`\\> Comments for param eventParam diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap index 0975242c1..13ccf4bf7 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap @@ -135,7 +135,7 @@ comment for y.z #### Parameters -• \`x\`: \`string\` +• **x**: \`string\` #### Returns @@ -147,7 +147,7 @@ comment for y.z #### Parameters -• \`x\`: \`string\` +• **x**: \`string\` #### Returns @@ -165,7 +165,7 @@ Comments for accessorA setter #### Parameters -• \`x\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\> +• **x**: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\> #### Returns @@ -179,7 +179,7 @@ Comments for accessorA setter #### Parameters -• \`x\`: \`string\` +• **x**: \`string\` #### Returns @@ -191,7 +191,7 @@ Comments for someFunction #### Parameters -• \`param\`: \`string\` +• **param**: \`string\` #### Returns @@ -282,9 +282,9 @@ Comments for FunctionType ## Parameters -• \`name\`: \`string\` +• **name**: \`string\` -• \`value\`: \`unknown\` +• **value**: \`unknown\` ## Returns diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap index f40a8e9fa..5abf3d96e 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.variable.spec.ts.snap @@ -169,7 +169,7 @@ Comments for objectLiteralVariable #### Parameters -• \`z\`: \`string\` +• **z**: \`string\` #### Returns @@ -206,9 +206,9 @@ Comments for objectLiteralVariable #### Parameters -• \`unionParam\`: \`"a"\` \\| \`"b"\` +• **unionParam**: \`"a"\` \\| \`"b"\` -• \`\\_undercoreParam\\_\`: \`string\` +• **\\_undercoreParam\\_**: \`string\` #### Returns diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap index 5e137ed26..56dde70ae 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap @@ -11,10 +11,6 @@ exports[`Text should get translations for index page: (Output File Strategy "mem - [module-1](module-1/README.md) - [module-2](module-2/README.md) - -*** - -Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org). " `; @@ -38,10 +34,6 @@ exports[`Text should get translations for member page: (Output File Strategy "me | Event! | Type | | :------ | :------ | | \`someEvent\` | \`MouseEvent\` | - -*** - -Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org). " `; @@ -59,10 +51,6 @@ exports[`Text should get translations for module page: (Output File Strategy "me ### 多变的 - [SomeInterface](interfaces/SomeInterface.md) - -*** - -Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org). " `; @@ -80,10 +68,6 @@ exports[`Text should get translations for modules page: (Output File Strategy "m ### constA > **\`const\`** **constA**: \`true\` = \`true\` - -*** - -Generated using [TypeDoc](https://typedoc.org) and [typedoc-plugin-markdown](https://typedoc-plugin-markdown.org). " `; diff --git a/packages/typedoc-plugin-remark/test/typedoc.base.json b/packages/typedoc-plugin-remark/test/typedoc.base.json index c05ec3c1c..44df93ae4 100644 --- a/packages/typedoc-plugin-remark/test/typedoc.base.json +++ b/packages/typedoc-plugin-remark/test/typedoc.base.json @@ -7,7 +7,6 @@ "parametersFormat": "table", "disableSources": true, "cleanOutputDir": true, - "hideGenerator": true, "hidePageHeader": true, "hideBreadcrumbs": true } diff --git a/packages/typedoc-vitepress-theme/test/typedoc.base.json b/packages/typedoc-vitepress-theme/test/typedoc.base.json index 9eaf4cc90..fcf9fccbc 100644 --- a/packages/typedoc-vitepress-theme/test/typedoc.base.json +++ b/packages/typedoc-vitepress-theme/test/typedoc.base.json @@ -6,7 +6,6 @@ "readme": "none", "disableSources": true, "cleanOutputDir": true, - "hideGenerator": true, "hidePageHeader": true, "hideBreadcrumbs": true }