https://github.com/drewmoore/memorygame
https://github.com/drewmoore/memorygame
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/drewmoore/memorygame
- Owner: drewmoore
- Created: 2014-07-18T06:24:13.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-18T06:29:45.000Z (almost 12 years ago)
- Last Synced: 2025-03-06T04:46:58.518Z (over 1 year ago)
- Language: JavaScript
- Size: 7.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docdown v1.0.0
## `docdown`
* [`docdown`](#docdown$optionsarray)
## `docdown`
### `docdown([$options=array()])`
# [Ⓢ](https://github.com/jdalton/docdown/blob/master/docdown.php#L34 "View in source") [Ⓣ][1]
Generates Markdown from JSDoc entries in a given file.
#### Arguments
1. `[$options=array()]` *(Array)*: The options array.
#### Returns
*(String)*: The generated Markdown.
#### Example
```php
// specify a file path
$markdown = docdown(array(
// path to js file
'path' => $filepath,
// url used to reference line numbers in code
'url' => 'https://github.com/username/project/blob/master/my.js'
));
// or pass raw js
$markdown = docdown(array(
// raw JavaScript source
'source' => $rawJS,
// documentation title
'title' => 'My API Documentation',
// url used to reference line numbers in code
'url' => 'https://github.com/username/project/blob/master/my.js'
));
```
* * *
[1]: #docdown "Jump back to the TOC."