Open snoweuph opened 2 years ago
This isn't one of the goals of TSDoc. TSDoc only describes how comments ought to be parsed, and it leaves generating documentation up to tools which implement the TSDoc spec. https://api-extractor.com/ is one tool which does this
@Gerrit0 have you given typedoc a spin?
"devDependencies": {
"typedoc": "0.23.14"
},
"scripts": {
"typedoc": "npx typedoc --excludeExternals --cleanOutputDir --out <TARGET_DIR_FOR_OUTPUT> src/index.ts"
}
With jsdoc, I could easily auto-generate a whole website. Is something like this possible with tsdoc too, because I didn't find any description of it anywhere. If there is no way yet, will there be a way in the future maybe or is this completely out of the goals of this project?