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
697 stars 173 forks source link

fix: spaces in filenames results in broken links #466

Closed carlosingles closed 11 months ago

carlosingles commented 11 months ago

This fixes an issue I encountered when using the gitlab-wiki-theme.

The links that are generated have a - that replaces spaces in the referenced reflections, however the filenames of the relevant reflections still have spaces. This leads to all links with spaces being broken in the gitlab wiki.

This is on GitLab Enterprise Edition v16.0.4-ee

Using the following dependency tree:

> npm ls typedoc
my-package ~/my-package
├─┬ typedoc-gitlab-wiki-theme@1.1.0
│ └── typedoc@0.25.1 deduped
├─┬ typedoc-plugin-markdown@3.16.0
│ └── typedoc@0.25.1 deduped
└── typedoc@0.25.1
carlosingles commented 11 months ago

apologies, made a mistake when cleaning up branch, the PR is here now: #467