mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-01 23:57:49 +00:00
45 lines
1.2 KiB
Markdown
45 lines
1.2 KiB
Markdown
# Docdown <sup>v1.0.0-pre</sup>
|
|
|
|
A simple JSDoc to Markdown documentation generator.
|
|
|
|
## Documentation
|
|
|
|
The documentation for Docdown can be viewed here: [/doc/README.md](https://github.com/jdalton/docdown/blob/master/doc/README.md#readme)
|
|
|
|
For a list of upcoming features, check out our [roadmap](https://github.com/jdalton/docdown/wiki/Roadmap).
|
|
|
|
## Installation and usage
|
|
|
|
Usage example:
|
|
|
|
~~~ php
|
|
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:
|
|
|
|
~~~ bash
|
|
git clone https://github.com/docdown/docdown.git
|
|
cd docdown
|
|
~~~
|
|
|
|
Feel free to fork and send pull requests if you see improvements!
|
|
|
|
## Author
|
|
|
|
* [John-David Dalton](http://allyoucanleet.com/)
|
|
[](https://twitter.com/jdalton "Follow @jdalton on Twitter")
|
|
|
|
## Contributors
|
|
|
|
* [Mathias Bynens](http://mathiasbynens.be/)
|
|
[](https://twitter.com/mathias "Follow @mathias on Twitter")
|