Sample project with tsup and tsc, generates the documentation TSDOC standard and typedoc tool
🏄🏻♀️ https://hidocs.netlify.app/
npm i hidocs
import {sayGoodbye, sayHello} from 'hidocs'l
console.log(sayHello("Thiago");
console.log(sayGoodbye({ name: "John", age: 30 }));
git clone git@github.com:tgmarinho/poc-ts-doc.git
cd poc-ts-doc/example
npm i
You can code example/src/index.ts file.
- https://tsdoc.org/
- https://tsdoc.org/play#
- https://typedoc.org/
- https://typedoc.org/example/
- eslint-plugin-tsdoc
- documenting your typescript projects
- generating documentation for typescript-projects
- how to write ts interfaces in jsdoc
🧢 Thiago Marinho