A simple and opinionated TypeScript docs generator designed to effortlessly create comprehensive API documentation for your TypeScript projects. Embracing a straightforward approach, this tool leverages JSDoc annotations within your codebase, automating the process of generating clear, organized, and easily navigable documentation for your APIs.
npm i @vyke/tsdocs -DAdd a script to your package.json for easy execution:
{
"scripts": {
"generate-docs": "tsdocs"
}
}Make sure you have a API section in your README.md file
<!-- README.md -->
## APIGenerates api docs base on the jsdocs on the exports functions
Replace the old api section with the given one