Implementation of additional MD files

[Voo2]

Search Terms

Markdown, additional documentation, include

Problem

I would like to see TypeDoc offers the possibility to include additional MarkDown documents.

Suggested Solution

I find the way Compodoc solves it ideal. There, the files that have the same name as the component, but with the md file extension, are simply included as a separate tab.

Here is an example in an Angular project:

--example.component.ts
--example.component.scss
--example.component.html
--example.component.md

In this example, typedoc would recognise that an md file exists for this component, which should be included. In order to access this document, typedoc then creates a tab on the doc page for the component, with which one can switch to this additional documentation.

Of course, this can also be done in another way, e.g. by simply adding a section to the doc page of the component where the additional page is located.

[Gerrit0]

Duplicate of #247, something I want to do at some point when I have a couple weeks to work on typedoc again

[Dayday10]

What happened?

…

On Sat, Aug 19, 2023, 10:17 AM Gerrit Birkeland ***@***.***> wrote: Closed #2365 <#2365> as not planned. — Reply to this email directly, view it on GitHub <#2365 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AWMIKFNY5CYIWGDMWHEU7KTXWDKJPANCNFSM6AAAAAA3SCNPTU> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[Voo2]

Good question. In #247 it is not apparent to me. Does that mean you no longer want to do this?

[Gerrit0]

Inclusion of markdown support documents as a feature in general is tracked by 247, I don't feel the need to track it in multiple issues. The design I have in mind will support both the "here's a folder of docs" and "here's supplemental docs" use cases.