Generate pages corresponding to Markdown files in directories

[DanielFlaum]

TypeDoc currently includes the content of README.md in the generated index.html. It would be useful if README.mds in subdirectories also caused corresponding pages to be generated. Doing so would add a way for directories themselves to be documented, creating a place to discuss project organization or other things that apply to more than a single file, as well as a place to document non-TypeScript files.

This should probably be labelled enhancement and plugin idea.

[Gerrit0]

This is something I'd like to include in TypeDoc itself, but will probably be a part of the guides work that's planned for 0.24, probably won't happen for a while...

[cadavre]

Another, maybe simpler way, would be to just list a docs files with their path and create static docs from it, in a separate menu. Just to wrap existing docs into code-generated one.

[johnameyer]

I see the Guides project board is now closed - do there happen to be plans for this idea now?

[Gerrit0]

I believe I closed it since GitHub started redirecting "old" projects to the new projects, and haven't gotten around to creating a new one since I've been meaning to finish 0.24 first, which won't include it. Have been busy with other things recently...

[Voo2]

I would go one step further and say that generally all md files should be taken into account.

Suggested Solution

Similar to what Compodoc does, it would be extremely helpful if typedoc would consider md (Markdown) files that are in the same directory as the class and have the same filename. These MD files could be displayed in a tab from the displayed class or linked quite high up in the document.

Example

• startup-config.service.ts
• startup-config.service.md (this is the md file that belongs to the file above and should be integrated into its documentation)

[LeaVerou]

Another vote for this. We have a monorepo-like structure with components living in their own directories, with their own READMEs. It would be nice if those READMEs were also picked up by typedoc.

[Gerrit0]

Fixed with TypeDoc 0.26, which is releasing 2024/06/21