mark-down-my-docs
MarkDown generator for .js and .ts source files with jsdoc documentation blocks
Why?
I was looking for an out-of-the-box, simple-to-setup documentation generator for a project of mine. So I could easily generate my documentation for this project. It was harder than it sounded, too hard. Turns out that it didn't exist, or I could not find it. That's why I created this package, hope it helps you as much as it helped me.
These were my demands
- Runs right away after installation without extra setup.
- Supports typescript and javascript.
- Supports jsdoc.
- Generates MarkDown files.
- Has as few dependencies as possible.
- Is fast
- Is a node application
Installation
npm install mark-down-my-docs Usage
Run command with source directory and docs directory.
mark-down-my-docs src/ docs/
Support
supports .js and .ts files with js-doc blocks
runs on node 14.x and 16.x