Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
src/DocDown
LICENSE.txt
README.md
docdown.php

README.md

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

Something went wrong with that request. Please try again.