search

typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
689 stars 172 forks source link

Broken links in some local wiki reference #628

Closed TL-Luca-Ricci closed 2 weeks ago

TL-Luca-Ricci commented 3 weeks ago

What package is the bug related to?

typedoc-gitlab-wiki-theme

Describe the issue

Some references to other wiki pages (usually to interfaces and enums, never see bad classes references) aren't stripped from .md extensions making the wiki point to the source page (raw content) instead of the actual page (with interpreted markdown)

TypeDoc configuration

{
    "$schema": "https://typedoc.org/schema.json",
    "entryPoints": ["./src/api.ts"],
    "plugin": ["typedoc-plugin-markdown", "typedoc-gitlab-wiki-theme"],
    "readme": "none",
    "enumMembersFormat": "table",
    "expandObjects": true,
    "parametersFormat": "table",
    "expandParameters": true,
    "propertiesFormat": "table",
    "typeDeclarationFormat": "table",
    "indexFormat": "table",
    "flattenOutputFiles": false,
    "out": "wiki"
}

Expected behavior

All the links should have the .md extension removed

tgreyuk commented 3 weeks ago

Should be fixed in typedoc-gitlab-wiki-theme@.2.0.1