documentationjs-markdown-api-example
An example for documentationjs + markdown reference.
Update Usage
Automatically, update "Usage" section with documentation result.
npm install
npm run update:docs
Usage
Table of Contents
hello
Return Hello message
Parameters
name
string
Examples
hello("john"); // => "Hello, john"
Returns string
updateProp
update property with propertyValue
if the propertyName
does not exists
Parameters
object
anypropertyName
stringpropertyValue
stringoptions
{force: boolean} (optional, default{force:false}
)
Examples
const object = {};
update(object, "key", "value", { force: true })
console.log(object); // { key: "value" }
Myclass
report
report message
Parameters
message
string
Changelog
See Releases page.
Running tests
Install devDependencies and Run npm test
:
npm test
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu