An example for documentationjs + markdown reference.
Automatically, update "Usage" section with documentation result.
npm install
npm run update:docs
Return Hello message
namestring
hello("john"); // => "Hello, john"Returns string
update property with propertyValue if the propertyName does not exists
objectanypropertyNamestringpropertyValuestringoptions{force: boolean} (optional, default{force:false})
const object = {};
update(object, "key", "value", { force: true })
console.log(object); // { key: "value" }report message
messagestring
See Releases page.
Install devDependencies and Run npm test:
npm test
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
MIT © azu