Skip to content

Latest commit

 

History

History
 
 

docdown

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

Docdown v1.0.0-pre

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"
));

Cloning this repo

To clone this repository just use:

git clone https://github.com/docdown/docdown.git
cd docdown

Feel free to fork and send pull requests if you see improvements!

Author

Contributors