-
Notifications
You must be signed in to change notification settings - Fork 184
Description
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
When updating from 4.2.2 to 4.6.2 I noticed all my page headings were incorrect. I'm using @group to organize my types and it appears that whichever the first group it finds is used for all of them?
I have this for my pageTitleTemplates
pageTitleTemplates: {
member: (args) => `${args.group}: ${args.name}`,
},
But this type
/**
* A type guard for determining if a value is a valid URL.
* @param value - The value to check.
* @returns `true` if the value is a valid URL, otherwise `false`.
* @group Type Guards
*/
export declare function isUrl(value: unknown): value is Url;Is rendered as
Compositions: usUrl()
"Compositions" is another group. It happens to be the first group used. If I change my types so a different group is rendered first, then that group's name will be used. This happens for every title. They all end up using the first group no matter what the actual group for that type is.
TypeDoc configuration
export default {
$schema: "https://typedoc.org/schema.json",
entryPoints: ["./dist/kitbag-router.d.ts"],
plugin: [
"typedoc-plugin-markdown",
"typedoc-vitepress-theme",
],
out: "./docs/api",
docsRoot: "./docs/",
tsconfig: "./typedoc.tsconfig.json",
readme: "none",
parametersFormat: "table",
propertiesFormat: "table",
hideBreadcrumbs: true,
hidePageHeader: true,
useCodeBlocks: true,
disableSources: true,
groupOrder: [
"Compositions",
"Errors",
"Interfaces",
"Type Guards",
"Type Aliases",
"Utilities",
"*",
],
pageTitleTemplates: {
member: (args) => ${args.group}: ${args.name},
},
}
Expected behavior
The correct group should be used for each page title