| 1 | apiguide
|
| 2 | =============
|
| 3 |
|
| 4 | Node.js module to generate jsdoc with theme colors.
|
| 5 |
|
| 6 |
|
| 7 |
|
| 8 | [![Build Status][my_travis_badge_url]][my_travis_url]
|
| 9 | [![Code Climate][my_codeclimate_badge_url]][my_codeclimate_url]
|
| 10 | [![Code Coverage][my_codeclimate_coverage_badge_url]][my_codeclimate_url]
|
| 11 | [![npm version][my_npm_budge_url]][my_npm_url]
|
| 12 |
|
| 13 | Usage
|
| 14 | -----
|
| 15 |
|
| 16 |
|
| 17 | ```javascript
|
| 18 | var apiguide = require('apiguide');
|
| 19 | apiguide([
|
| 20 | "lib/**/*.js",
|
| 21 | "README.md"
|
| 22 | ], {
|
| 23 | destination: "docs/apiguide",
|
| 24 | verbose: true,
|
| 25 | templates: {
|
| 26 | color: '#38E'
|
| 27 | }
|
| 28 | }, function(err) {
|
| 29 |
|
| 30 | });
|
| 31 | ```
|
| 32 |
|
| 33 | Options
|
| 34 | -----
|
| 35 |
|
| 36 | | Key | Description |
|
| 37 | | --- | ----------- |
|
| 38 | | verbose | Verbose or not. |
|
| 39 | | tutorials | Directory path for tutorials. |
|
| 40 | | destination | Destination directory path. |
|
| 41 | | templates | Markup options. |
|
| 42 | | templates.systemName | Name of theme. |
|
| 43 | | templates.footer | Footer html. |
|
| 44 | | templates.copyright | Copyright string. |
|
| 45 | | templates.color | Theme color. |
|
| 46 |
|
| 47 |
|
| 48 | Installation
|
| 49 | -----
|
| 50 |
|
| 51 | ```bash
|
| 52 | npm install argx --save-dev
|
| 53 | ```
|
| 54 |
|
| 55 |
|
| 56 | License
|
| 57 | -------
|
| 58 | This software is released under the [MIT License][my_license_url].
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 | [nodejs_url]: http://nodejs.org/
|
| 65 | [npm_url]: https://www.npmjs.com/
|
| 66 | [nvm_url]: https://github.com/creationix/nvm
|
| 67 | [bitdeli_url]: https://bitdeli.com/free
|
| 68 | [my_bitdeli_badge_url]: https://d2weczhvl823v0.cloudfront.net/okunishinishi/node-apiguide/trend.png
|
| 69 | [my_repo_url]: https://github.com/okunishinishi/node-apiguide
|
| 70 | [my_travis_url]: http://travis-ci.org/okunishinishi/node-apiguide
|
| 71 | [my_travis_badge_url]: http://img.shields.io/travis/okunishinishi/node-apiguide.svg?style=flat
|
| 72 | [my_license_url]: https://github.com/okunishinishi/node-apiguide/blob/master/LICENSE
|
| 73 | [my_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-apiguide
|
| 74 | [my_codeclimate_badge_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-apiguide.svg?style=flat
|
| 75 | [my_codeclimate_coverage_badge_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-apiguide.svg?style=flat
|
| 76 | [my_apiguide_url]: http://okunishinishi.github.io/node-apiguide/apiguide
|
| 77 | [my_lib_apiguide_url]: http://okunishinishi.github.io/node-apiguide/apiguide/module-apiguide_lib.html
|
| 78 | [my_coverage_url]: http://okunishinishi.github.io/node-apiguide/coverage/lcov-report
|
| 79 | [my_coverage_report_url]: http://okunishinishi.github.io/node-apiguide/coverage/lcov-report/
|
| 80 | [my_gratipay_url]: https://gratipay.com/okunishinishi/
|
| 81 | [my_gratipay_budge_url]: http://img.shields.io/gratipay/okunishinishi.svg?style=flat
|
| 82 | [my_npm_url]: http://www.npmjs.org/package/apiguide
|
| 83 | [my_npm_budge_url]: http://img.shields.io/npm/v/apiguide.svg?style=flat
|
| 84 | [my_tag_url]: http://github.com/okunishinishi/node-apiguide/releases/tag/
|
| 85 | [my_tag_badge_url]: http://img.shields.io/github/tag/okunishinishi/node-apiguide.svg?style=flat
|
| 86 |
|
| 87 | |
| \ | No newline at end of file |