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

v4.1 removes relative link

Open arantes555 opened this issue 1 year ago • 0 comments
trafficstars

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

I am using typedoc with typedoc-plugin-markdown to generate .md documentation of a package.

In the entry point of this package, there is some header documentation for the module with @module. This gets exported to an index.md file.

This documentation contains a relative link to somewhere else in my documentation, outside of this package (the exact link is [here](../../api-ssks/index.md), if that is relevant somehow).

In v4.0.4 with typedoc v0.25.13, this link is correctly present in the index.md output.

In v4.1.0 with typedoc v0.26.0, the link is transformed into [here]() in the output.

TypeDoc configuration

{
  "entryPoints": ["./src/lib/main.ts"],
  "out": "../../doc-sdk/ssks-2mr",
  "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
  "categoryOrder": ["*"],
  "excludeInternal": true,
  "disableSources": true,
  "hideBreadcrumbs": true,
  "hideGenerator": true,
  "sidebar": {
    "autoConfiguration": false
  },
  "githubPages": false,
  "readme": "none"
}

Expected behavior

The link should not be removed.

arantes555 avatar Jul 03 '24 15:07 arantes555