doxdox
A simple solution for auto generated documentation.
Convert JSDoc to Markdown, Bootstrap, custom JavaScript templates, and more!
Getting Started
Install doxdox as a development dependency.
npm install doxdox --save-devThen add a new target to your package.json scripts object.
{
"scripts": { "docs": "doxdox --renderer markdown --output DOCUMENTATION.md" }
}Badges
Add the following badge to your README for dynamically generated documentation based on the URL referer.
[](https://doxdox.org/)Explore
- enchilada
🌯 A collection of files and opinionated code used to set up projects. Check the repo Wiki for more info.
- hypedataparser
Helper to parse strings into JavaScript multiple data formats and to easily extract specific facets from the data
- promise-throttle
A small library to throttle promises. Useful to avoid rate limiting when using REST APIs.
