https://github.com/thlorenz/docme
Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.
https://github.com/thlorenz/docme
Last synced: 22 days ago
JSON representation
Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.
- Host: GitHub
- URL: https://github.com/thlorenz/docme
- Owner: thlorenz
- License: mit
- Created: 2013-12-16T13:47:48.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-04-23T18:48:53.000Z (about 10 years ago)
- Last Synced: 2025-06-05T23:18:09.257Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://github.com/thlorenz/docme
- Size: 314 KB
- Stars: 56
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docme [](http://travis-ci.org/thlorenz/docme)
Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.
## Installation
npm install docme
## Usage
```
docme --Generates jsdocs for non-private members of the project in the current folder.
It then updates the given README with the githubified version of the generated API docs.Note: overriding the jsdoc destination (-d, --destination) is not possible since docme will write files to a temp dir
OPTIONS:
-l, --loglevel level at which to log: silly|verbose|info|warn|error|silent -- default: info
-h, --help Print this help message.EXAMPLES:
Generate with default options and update README.md
docme README.mdOverride [jsdocconf.json](http://usejsdoc.org/about-configuring-jsdoc.html):
docme README.md -- --configure ./myconf.json
Override loglevel and jsoc configuration:
docme API.md --loglevel silly -- --configure ./myconf.json
```**Note:** all functions that are not part of the public API should be [marked as `@private`](https://github.com/thlorenz/docme/blob/2bf813946aa8f13f2503d3fac8b3c9c27e24594e/lib/docmeify.js#L35) in order to exclude them from
the docs generated by `docme`.## Helpful links
Since docme is using [jsdoc](http://usejsdoc.org/) under the hood, it is helpful to review its documentation. I
**highly recommend** [this page](https://developers.google.com/closure/compiler/docs/js-for-compiler#types) explaining
how to specify `@param` types among other useful specs.In order to make your docme APIs appear properly styled, please [install the chrome extension or bookmarklet](http://thlorenz.github.io/jsdoc-githubify-inject/).
## API
docme(readme, args, jsdocargs, cb)Generates jsdocs for non-private members of the project in the current folder.
It then updates the given README with the githubified version of the generated API docs.Parameters:
Name
Type
Description
readme
String
path to readme in which the API docs should be updated
args
Array.<String>
consumed by docme
Properties
Name
Type
Argument
Description
loglevel
String
<optional>
(info) level at which to log: silly|verbose|info|warn|error|silent
jsdocargs
Array.<String>
consumed by jsdoc
cb
function
called back when docme finished updating the README
*generated with [docme](https://github.com/thlorenz/docme)*
## License
MIT