typedoc2md/typedoc-plugin-markdown

flattenOutputFiles is true, but the name structure should be text-text-text-text.md

Closed this issue · 3 comments

Xtravaganz commented

What package is the feature request related to?

typedoc-plugin-markdown

Background

Current state

grafik

Desired state

grafik

Is it possible to get an option for this in the config?

It would be very cumbersome to parse every Markdown and set the link structure so that the files can be found accordingly

Since we use relative paths in the web page structure this would be a great help, I would like to avoid this unnecessary README.md creation in the extended folder creation that comes up in the flattenOutputFiles false.

Or perhaps I have overlooked the option in the documentation to separate the names with - instead of ., in which case I would appreciate a tip.

Proposed solution

No response

tgreyuk commented

Hi @Xtravaganz,

I understand the request to configure the filename convention.

Could you please clarify this point?

Since we use relative paths in the web page structure this would be a great help, I would like to avoid this unnecessary README.md creation in the extended folder creation that comes up in the flattenOutputFiles false.

Xtravaganz commented

Hi @Xtravaganz,

I understand the request to configure the filename convention.

Could you please clarify this point?

Since we use relative paths in the web page structure this would be a great help, I would like to avoid this unnecessary README.md creation in the extended folder creation that comes up in the flattenOutputFiles false.

Of course:
grafik
I prefer directly the jump to MainController without the README.md jump.

grafik
grafik

But here is in both cases the flattenOutputFiles = false!