doxdox

A simple solution for auto generated documentation.

Convert JSDoc to Markdown, Bootstrap, custom JavaScript templates, and more!

Example documentation generated with a Bootstrap template.

Getting Started

Install doxdox as a development dependency.

npm install doxdox --save-dev

Then 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.

[![Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/)

Explore