@vyke/tsdocs
v0.0.8
Published
<div align="center"> <h1> @vyke/tsdocs </h1> </div>
Downloads
4
Readme
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.
Installation
npm i @vyke/tsdocs -D
Add 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 -->
## API
API
generateApi
Generates api docs base on the jsdocs on the exports functions
replaceApiSection
Replace the old api section with the given one