0.3.5 • Published 1 year ago

micro-docgen v0.3.5

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

micro-docgen

Simple documentation generator for TypeScript projects.

⚠️ WIP!! Currently only supports class serialization

Example

const { Docgen } = require('micro-docgen');
const docgen = new Docgen();
const fs = require('fs');

// add source file(s)
docgen.addFiles('./src/*.ts');

// Generate json
const documentation = docgen.generate();

// write the output to docs.json
fs.writeFileSync('./docs.json', JSON.stringify(documentation, null, '\t'));