This project can help you generate api doc as markdown ,by reading the notes from ts files.
npm install ye-ts2doc -D
In just two steps, you can convert ts files into API documentation
To use ye-ts2doc, you should firstly create the ts2doc.config.js
under you project.
//ts2doc.config.js
const path = require("path")
module.exports = {
input: <the file path that the ts file you want to parse>,
output: <the output path the markdown file generated>,
filename: <the name of the output markdown file>,
publicOnly: <if only parse public methods or properties>,
}
Next, execute the following command
ts2doc
now , you can find markdown file in you output file!