Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 985 Bytes

README.md

File metadata and controls

33 lines (21 loc) · 985 Bytes

Docdown v1.0.0

A simple JSDoc to Markdown documentation generator.

Documentation

The documentation for Docdown can be viewed here: /doc/README.md

For a list of upcoming features, check out our roadmap.

Installation and usage

Usage example:

require("docdown.php");

// generate Markdown
$markdown = docdown(array(
  "path" => $filepath,
  "url"  => "https://github.com/username/project/blob/master/my.js"
));

Author

Contributors