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

Handling case sensitive files is broken #555

Closed gossi closed 4 months ago

gossi commented 5 months ago

Here is my situation

There is

That's a case the markdown plugin cannot handle very well, here is my PR in which I tried to update the existing vitepress docs with the new plugin: buschtoens/ember-link#793 (repro manual at the end of this post)

Markdown

Vitepress Integration

That's the error in the console, when I open Link:

Bildschirmfoto 2024-01-28 um 10 52 37

Interesting to see, it comes to set -> Ember (or is it Ember.set ?) at the end. Even though that is quite old code (before there were classes in JS), that shouldn't break, no?

What works though, is the sidebar is correct:

Bildschirmfoto 2024-01-28 um 10 55 04

Reproduction

Here is the reproduction with a manual:

  1. Check out buschtoens/ember-link#793
  2. Install pnpm install
  3. Into ember-link folder: cd ember-link/ and generate API with: pnpm api
  4. Go back into repo root: cd ../ and start vitepress: pnpm docs:dev
  5. Open the link and navigate to the API (top right navigation)
tgreyuk commented 5 months ago

Thanks.

So the plugin now produces the following files in this scenario.

Fix versions:

"typedoc-plugin-markdown": "^4.0.0-next.45",
"typedoc-vitepress-theme": "^1.0.0-next.8",

Result

2024-01-30 22 05 57