An example for documentationjs + markdown reference.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
package.json
yarn.lock

README.md

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

Examples

hello("john"); // => "Hello, john"

Returns string

updateProp

update property with propertyValue if the propertyName does not exists

Parameters

  • object any
  • propertyName string
  • propertyValue string
  • options {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

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.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu