Skip to content
This repository has been archived by the owner on Mar 9, 2023. It is now read-only.
/ docredux Public archive

Dead simple documentation generator with built in dead simple unit testing.

License

Notifications You must be signed in to change notification settings

tomekmarchi/docredux

Repository files navigation

Docredux

Dead simple documentation generator for JSDOC syntax. Docredux plucks out the JSDOC syntax inside of your compiled code and returns an organized JSON structure and saves it to a JSON file. The generated JSON Object is then used for creating an HTML documentation website for the code.

Example

The destination is the location where the generated file will save.

const docredux = require('docredux');
docredux.build.json({
  destination: `${__dirname}/docs/`,
  source: `${__dirname}/docs/bundle.js`,
});

© copyright 2020 Universal Web, Inc

About

Dead simple documentation generator with built in dead simple unit testing.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •