[typedoc-vitepress-theme]: Anchors generated by typdoc will not be compatible with vitepress if they contain colon

[aiktb]

What package is the bug related to?

typedoc-vitepress-theme

Describe the issue

For example, I have an object property named "build:before", the anchor generated by typedoc is "buildbefore", but the anchor generated by vitepress is "build-before".

More Information

typedoc-plugin-markdown/packages/typedoc-vitepress-theme/src/index.ts

Lines 78 to 85 in 834b810

	function slugifyAnchor(anchor: string) {
	return anchor
	.toLowerCase()
	.trim()
	.replace(/[^\w\s-]/g, '')
	.replace(/[\s_-]+/g, '-')
	.replace(/^-+|-+$/g, '');
	}

I noticed that the above implementation is wrong. Line 82 eliminates all non-alphanumeric and "-" characters, which is inconsistent with the implementation of VitePress.

https://github.com/vuejs/vitepress/blob/452d6c77a6afa43faa245452e7d0b360e55a36fb/src/node/markdown/markdown.ts#L16

I found the anchor generation code used by vitepress, we can reuse it.

https://github.com/mdit-vue/mdit-vue/blob/e0c38a4a7d0565a2c4c59dcfbb7e58aa38dc12e3/packages/shared/src/slugify.ts#L1-L25

TypeDoc configuration

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPointStrategy": "packages",
  "entryPoints": ["../packages/wxt"],
  "plugin": [
    "typedoc-plugin-markdown",
    "typedoc-vitepress-theme",
    "typedoc-plugin-frontmatter"
  ],
  "out": "./api/reference",
  "githubPages": false,
  "excludePrivate": true,
  "excludeProtected": true,
  "excludeInternal": true,
  "readme": "none",
  "frontmatterGlobals": {
    "editLink": false
  }
}

Expected behavior

typedoc generates "build-before" anchor.

[aiktb]

If typedoc2md members thinks my understanding is correct, I can open a PR for this. 😊

[tgreyuk]

Yes this sounds good. Feel free to open a PR - but if not will get it fixed shortly.

[aiktb]

Yes this sounds good. Feel free to open a PR - but if not will get it fixed shortly.

Hi, I found that the anchors in the table of contents generated by typedoc-plugin-markdown have already removed the colon, so this bug is not caused by typedoc-vitepress-theme.
I didn't find the reason.

[tgreyuk]

I have updated the anchors to be same as vitepress so it might fix your issue. typedoc-vitepress-theme@1.1.1

[aiktb]

I have updated the anchors to be same as vitepress so it might fix your issue. typedoc-vitepress-theme@1.1.1

Thanks for your reply and work.

I have tried this and it didn't solve the problem.

I am sure that the colon in the anchor is eliminated before it is processed by typedoc-vitepress-theme, I tried to look for the logic in typedoc-plugin-markdown that handles anchors, but I can't understand it.

[tgreyuk]

ok thanks for checking. Do you have a reproduction on a public repo so i can investigate properly? Anchors can be created in various places and it is hard to figure out the issue without something to test against.

[tgreyuk]

Otherwise a screenshot identifying which link is broken would help a lot.

[aiktb]

Otherwise a screenshot identifying which link is broken would help a lot.

I encountered a little difficulty. I was upgrading all dependencies related to typedoc, and what was actually broken was the ToC anchor in the markdown file.
When I upgraded the dependencies to the latest, the ToC disappeared, so I am still investigating why the ToC disappeared.

This issue can be reproduced at https://github.com/wxt-dev/wxt (I upgraded the latest "typedoc-vitepress-theme" locally, and there was no change remotely)
The broken link is at https://wxt.dev/api/reference/wxt/interfaces/WxtHooks.html

Do you have any idea about the disappearance of the ToC? If I restored the ToC I could create a minimal copy.

[aiktb]

Okay, I saw that 4.0.0 breaking changes introduced changes to typedoc-plugin-remark, and I'll create a minimal copy.

[aiktb]

Close this. ToC generation after 4.0.0 is no longer related to typedoc-vitepress-theme

Thank you!