Can typedoc output markdown?

[sidharthv]

Hi Sebastian,

From the DocComments page (http://typedoc.io/guides/doccomments.html) I see "All comments are parsed as markdown". How do you get the markdown for all comments? Would it be possible to output this markdown somehow?
If we could get markdown output for all the comments then we could use this markdown as documentation on GitHub, in say a Readme.md file. The html output is very useful, but if we wanted to put up our API documentation on GitHub then having markdown would really help.

Thanks!

[sebald]

You could use the JSON output and then iterate over everthing.

[JoshuaKGoldberg]

I'd like to use TypeDoc to generate README files in a number of projects. This feature would be super useful.

How difficult do you think it would be to implement as a native part of TypeDoc?

[0815fox]

You probably could write a template which produces MarkDown instead of html.

[aciccarello]

@0815fox, it looks like #251 tried to write a template which produces markdown but couldn't change the file extension. Do you know if this is possible?

[curioussavage]

This would be awesome so we could just use gitbook as the site.

[danmarshall]

Take a look at https://github.com/kimamula/typedoc-markdown-theme / https://www.npmjs.com/package/typedoc-markdown-theme
I'm not sure if it works with the latest TypeDoc or not.

[paldepind]

I'm not sure if it works with the latest TypeDoc or not.

It doesn't. 0.6.0 is the last version I can get it to work with.

[cancerberoSgx]

This works fine and is active: https://github.com/tgreyjs/typedoc-plugin-markdown

[aciccarello]

@cancerberoSgx Cool! Could you add that plugin to the readme?

[cancerberoSgx]

sure, I'm on it need some time,

[cancerberoSgx]

@aciccarello #769

[Gerrit0]

Closing - typedoc-plugin-markdown can be used to output markdown & is now advertised in the readme.