Batch generate markdown API documentation from a folder of jsdoc annotated source code. Useful for injecting API docs into project README files.
1. Install dependencies
npm install
2. Run command prompt
node ./docs.js
3. Specify input and output folder in prompt line
Both paths need to be in POSIX (Unix) syntax e.g. D:/path/to/your/folder
If no input path is given, current working directory will be selected.
If no output path is given, docs will be generated to ./docs.
This project is based on jsdoc-to-markdown and jsdoc. Source codes should be annoatated correctly, check their documentation for more information.