5.0.5 • Published 9 years ago
apeman-doc v5.0.5
apeman-doc
Document generator for apeman.
Installation
Install apeman-doc module via npm.
$ npm install apeman-doc -g
Usage
- Prepare an Apemanfile.js at your project root.
- Run the command via CLI.
Apemanfile.js
/** Example of Apemanfile.js */
'use strict'
module.exports = {
$cwd: __dirname,
$pkg: { /* ... */ },
$proto: [ /* ... */ ],
$api: { /* ... */ }
}
Then,
# Generate doc about current apemanfile.
$ apeman-doc apemanfile doc/apemanfile-doc.md
CLI Options
$ apeman-doc -h
Usage: apeman-doc [options]
Generate project documentation.
Options:
-h, --help output usage information
-V, --version output the version number
-o, --out <out> Output directory path.
-c, --configuration <configuration> Pathname of Apemanfile
-C, --context <context> Pathname of mock context file.
Examples:
$ apeman-doc -o doc/apdoc.md # Generate apemanfile doc.
Programmatic API
apeman-doc also provide programmatic API.
Firstly, install the module locally.
$ npm install apeman-doc --save-dev
Then,
'use strict'
const apemanDoc = require('apeman-doc')
apemanDoc("apemanfile", "doc/apemanfile-doc.md", {}).then(() => {
/* ... */
})
Programmatic Options
Key | Description | Default |
---|---|---|
out | Output directory path. | doc/apdoc.md |
configuration | Pathname of Apemanfile | |
context | Pathname of mock context file. |
License
This software is released under the MIT License.
Links
5.0.5
9 years ago
5.0.4
9 years ago
5.0.3
9 years ago
5.0.2
9 years ago
5.0.1
9 years ago
5.0.0
9 years ago
4.0.3
9 years ago
4.0.2
9 years ago
4.0.1
9 years ago
4.0.0
9 years ago
3.0.0
9 years ago
2.3.3
9 years ago
2.3.2
9 years ago
2.3.1
9 years ago
2.3.0
9 years ago
2.2.0
10 years ago
2.1.0
10 years ago
2.0.3
10 years ago
2.0.2
10 years ago
2.0.1
10 years ago
2.0.0
10 years ago
1.1.3
10 years ago
1.1.2
10 years ago
1.1.1
10 years ago
1.1.0
10 years ago
1.0.6
10 years ago
1.0.5
10 years ago
1.0.4
10 years ago
1.0.3
10 years ago
1.0.2
10 years ago
1.0.1
10 years ago
1.0.0
10 years ago