VitePress

Appearance

@snailicide/build-config / typedoc / MarkdownPluginOptions

MarkdownPluginOptions ​

Defined in: node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:4

Describes the options declared by the plugin.

Properties ​

PropertyTypeDescriptionDefined in
anchorPrefix?stringCustom anchor prefix to add to anchor links.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:8
blockTagsPreserveOrder?string[]Specifies comment block tags that should preserve their position.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:12
classPropertiesFormat?"table" | "list" | "htmlTable"Sets the format of property groups for classes.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:16
customAnchorsFormat?"curlyBrace" | "escapedCurlyBrace" | "squareBracket"The format of custom anchors.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:20
entryFileName?stringThe file name of the entry page.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:24
entryModule?stringDeprecated This functionality has been deprecated in favour of the Merge Module With tag.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:28
enumMembersFormat?"table" | "list" | "htmlTable"Sets the format of enumeration members.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:32
excludeGroups?booleanDeprecated This option has been renamed hideGroupHeadings to better reflect its purpose.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:36
excludeScopesInPaths?booleanExclude writing @ scope directories in paths.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:40
expandObjects?booleanExpand objects inside declarations.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:44
expandParameters?booleanExpand parameters in signature parentheses to display type information.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:48
fileExtension?stringSpecify the file extension for generated output files.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:52
flattenOutputFiles?booleanFlatten output files to a single directory.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:56
formatWithPrettier?booleanApply additional output formatting with Prettier.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:60
hideBreadcrumbs?booleanDo not print breadcrumbs.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:64
hideGroupHeadings?booleanExcludes grouping by kind so all members are rendered at the same level.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:68
hidePageHeader?booleanDo not print page header.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:72
hidePageTitle?booleanDo not print page title.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:76
indexFormat?"table" | "list" | "htmlTable"Sets the format of index items.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:80
interfacePropertiesFormat?"table" | "list" | "htmlTable"Sets the format of property groups for interfaces.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:84
membersWithOwnFile?("Enum" | "Variable" | "Function" | "Class" | "Interface" | "TypeAlias")[]Determines which members are exported to their own file.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:88
mergeReadme?booleanAppends the documentation index page to the readme page.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:92
modulesFileName?stringThe file name of the separate modules / index page.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:96
navigationModel?{ excludeGroups?: boolean; excludeCategories?: boolean; excludeFolders?: boolean; }Deprecated This option has been deprecated in favour of TypeDoc navigation option.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:100
navigationModel.excludeGroups?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:101
navigationModel.excludeCategories?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:102
navigationModel.excludeFolders?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:103
outputFileStrategy?"modules" | "members"Deprecated Deprecated in favour of --router.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:108
pageTitleTemplates?{ index?: string | (name) => string; member?: string | (name) => string; module?: string | (name) => string; }Configure page title output with placeholders.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:112
pageTitleTemplates.index?string | (name) => string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:113
pageTitleTemplates.member?string | (name) => string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:117
pageTitleTemplates.module?string | (name) => string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:126
parametersFormat?"table" | "list" | "htmlTable"Sets the format of parameter and type parameter groups.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:136
preserveAnchorCasing?booleanPreserve anchor casing when generating link to symbols.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:140
prettierConfigFile?stringSpecify a custom Prettier configuration file location.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:144
propertiesFormat?"table" | "list" | "htmlTable"Deprecated This option has been deprecated in favour of --interfacePropertiesFormat and --classPropertiesFormat.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:148
propertyMembersFormat?"table" | "list" | "htmlTable"Sets the format of style for property members for interfaces and classes.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:152
publicPath?stringSpecify the base path for all urls.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:156
sanitizeComments?booleanSanitize HTML and JSX inside JsDoc comments.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:160
strikeDeprecatedPageTitles?booleanControls whether deprecated symbols have their page titles rendered with a strikethrough.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:164
tableColumnSettings?{ hideDefaults?: boolean; hideInherited?: boolean; hideModifiers?: boolean; hideOverrides?: boolean; hideSources?: boolean; hideValues?: boolean; leftAlignHeaders?: boolean; }Control how table columns are configured and displayed.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:168
tableColumnSettings.hideDefaults?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:169
tableColumnSettings.hideInherited?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:170
tableColumnSettings.hideModifiers?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:171
tableColumnSettings.hideOverrides?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:172
tableColumnSettings.hideSources?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:173
tableColumnSettings.hideValues?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:174
tableColumnSettings.leftAlignHeaders?boolean-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:175
textContentMappings?{ header.title?: string; breadcrumbs.home?: string; title.indexPage?: string; title.memberPage?: string; title.modulePage?: string; }Deprecated This option has been deprecated in favour of --pageTitleTemplates.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:180
textContentMappings.header.title?string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:181
textContentMappings.breadcrumbs.home?string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:182
textContentMappings.title.indexPage?string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:183
textContentMappings.title.memberPage?string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:184
textContentMappings.title.modulePage?string-node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:185
typeAliasPropertiesFormat?"table" | "list" | "htmlTable"Sets the format of style for type alias properties.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:190
typeDeclarationFormat?"table" | "list" | "htmlTable"Sets the format of style for type declaration members.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:194
typeDeclarationVisibility?"compact" | "verbose"Set the visibility level for type declaration documentation.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:198
useCodeBlocks?booleanWraps signatures and declarations in code blocks.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:202
useCustomAnchors?booleanAdd custom anchors like {#custom-id} to headings.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:206
useHTMLAnchors?booleanAdd HTML anchors to page headings.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:210
useHTMLEncodedBrackets?booleanUse HTML encoded entities for angle brackets.node_modules/.pnpm/typedoc-plugin-markdown@4.8.0_typedoc@0.28.8_typescript@5.9.2_/node_modules/typedoc-plugin-markdown/dist/types/options.d.ts:214