tsdoc VS extractor

For what it’s worth, there’s also TSDoc[1] which is TypeScript’s sorta-equivalent spiritual successor, and notably uses the same format as JSDoc. Inline type annotation is great—and I vastly prefer it to JSDoc as a type annotation mechanism—but supporting the breadth of documentation capability in an inline code position would probably be unwieldy no matter how you try to accommodate it.

1: https://tsdoc.org/

Docs? TSdoc + TypeDoc or DocFX. Of particular interest, this can be used to generate JSON schema's, useful for REST / GraphQL

Nope, they look the same, at a glance, but they're not the same. JSDoc and TSDoc are different standards, developed by different teams.

JSDoc is a terrible standard. I would rather go for TypeScript + TSDoc, then use TypDoc to generate the actual documentation based on TS typings. Alternatively, you can go for Vue Styleguidist. It's an excellent tool, but, opposite to TSDoc it's not a standard, it's just a tool.

I am trying to use the @microsoft/tsdoc package to generate documentation for a given file. I followed the demo that hey have provided https://github.com/microsoft/tsdoc/tree/main/api-demo and it works for the sample input they provided, shown below.

Maybe this is of interest? https://tsdoc.org/

Awesome, thank you! Would you be willing to support TSDoc ?

The declarations (functions, variables, classes ...) and their docs are extracted with a custom API extractor I built based on the ts-morph library and the TypeScript compiler.

Thank you for your question, I don't have experience with Docusaurus but I'll try to list a few ideas, let me know if it can help you.

If you only need raw package metatada (signatures, docs...) that Docusaurus will render somehow at build time you may use my extractor which outputs a plain Javascript object with the collected information (see https://github.com/jsdocs-io/extractor/blob/main/test/packag...).

If you need pre-rendered docs that Docusaurus will embed in a page you may implement something like a React component (see https://github.com/jsdocs-io/web/blob/main/src/components/pa...) and use the raw metadata as component props.

If you need a pre-rendered page that Docusaurus will collect, you may want to look into https://www.npmjs.com/package/@microsoft/api-extractor which can directly output Markdown files (as well as JSON files) but requires some initial setup to get working.