Tsdx: Discussion: docs generator

[gozeon]

Current Behavior

npm run docs

Desired Behavior

Suggested Solution

• typedoc
• react-docgen-typescript

[jaredpalmer]

if we did something, I would like it to be more digestable than react-docgen or typedoc. Both of these spit out rather intimidating output IMHO. Some other work has been done in the space that I think is noteworthy:

• palantir/documentalist (powers https://blueprintjs.com/docs/)
• Framer’s API docs https://github.com/framer/api-docs/tree/master/api

[jaredpalmer]

Related to https://github.com/jaredpalmer/tsdx/issues/166

[slikts]

It would be nice if one of the more modern and maintained solutions like Docusaurus, ESDoc (with a TS plugin), Docz (if it wasn't only for React) or docsify (if it were static) could be used. palantir/documentalist seems to be not that well documented.

RxJS has a nice approach by using source code to show interface definitions, but it uses [dgeni], which is an another old and crusty tool.

TypeDoc is the most straightforwardly applicable tool, but its output is really unpolished compared to the nicer tools.

Generating TS docs is somehow an unexpectedly hairy problem, and it being solved would be a great boon.

Edit: the nicer examples of docs I could find (like this one) mostly seem to hand-write their API reference.

[gozeon]

@slikts
I think storybook is the best, but not enough automation

[slikts]

Storybook's just for React, and it's not a generator.

Links:

• ESDoc TS plugin (unmaintained)
• Docusaurus
• Docz
• Docusaurus TypeDoc plugin

[slikts]

A decent option is [typedoc-plugin-markdown]; here's [an example] of it being used with Docusaurus.

[shilman]

Storybook Docs is for React, Vue, Angular, Web-Components and a dozen other frameworks, as well as arbitrary MDX documentation.