You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
to generate great documentation for your JavaScript projects.
8
8
9
-
| name | description |
10
-
| ---- | ----------- |
11
-
|`options`| output options |
12
-
|`options.format`| either 'html', 'md', 'json', or 'docset'|
13
-
|`options.filename`| custom filename for md or json output |
14
-
15
-
Returns `stream.Transform`
16
-
17
9
## Installation
18
10
19
11
```sh
20
12
$ npm install --save-dev gulp-documentation
21
13
```
22
14
23
-
## Example
15
+
## API
16
+
17
+
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
18
+
19
+
### documentation
20
+
21
+
Documentation stream intended for use within the gulp system.
22
+
23
+
**Parameters**
24
24
25
-
```js
26
-
var documentation =require('gulp-documentation'),
27
-
gulp =require('gulp');
25
+
-`format`**\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** format - one of 'html', 'md', or 'json' (optional, default `md`)
26
+
-`options`**[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** documentation options - the same as given to [documentation](https://github.com/documentationjs/documentation)
27
+
-`options.filename`**[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** custom filename for md or json output
28
+
-`formatterOptions`**[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options - same as given to documentation
29
+
-`formatterOptions.name`**[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** if format is HTML, specifies the name of the project
28
30
31
+
**Examples**
32
+
33
+
```javascript
34
+
var gulpDocumentation =require('gulp-documentation'),
35
+
var gulp =require('gulp');
36
+
// Out of the box, you can generate JSON, HTML, and Markdown documentation
29
37
gulp.task('documentation', function () {
30
38
39
+
// Generating README documentation
31
40
gulp.src('./index.js')
32
-
.pipe(documentation({ format:'md' }))
41
+
.pipe(gulpDocumentation('md'))
33
42
.pipe(gulp.dest('md-documentation'));
34
43
44
+
// Generating a pretty HTML documentation site
35
45
gulp.src('./index.js')
36
-
.pipe(documentation({ format:'html' }))
46
+
.pipe(gulpDocumentation('html))
37
47
.pipe(gulp.dest('html-documentation'));
38
48
49
+
// Generating raw JSON documentation output
39
50
gulp.src('./index.js')
40
-
.pipe(documentation({ format:'json' }))
51
+
.pipe(gulpDocumentation('json'))
41
52
.pipe(gulp.dest('json-documentation'));
42
53
54
+
});
55
+
56
+
// Generate documentation for multiple files using normal glob syntax.
57
+
// Note that this generates one documentation output, so that it can
58
+
// easily cross-reference and use types.
59
+
gulp.task('documentation-multiple-files', function () {
60
+
61
+
gulp.src('./src/*.js')
62
+
.pipe(gulpDocumentation({ format: 'md' }))
63
+
.pipe(gulp.dest('md-documentation'));
64
+
65
+
});
66
+
67
+
68
+
// If you're using HTML documentation, you can specify additional 'name'
69
+
// and 'version' options
70
+
gulp.task('documentation-html-options', function () {
71
+
72
+
gulp.src('./src/*.js')
73
+
.pipe(gulpDocumentation('html', {}, {
74
+
name: 'My Project',
75
+
version: '1.0.0'
76
+
}))
77
+
.pipe(gulp.dest('html-documentation'));
78
+
79
+
});
80
+
81
+
// Document non-JavaScript files with JSDoc comments using polyglot: true
82
+
gulp.task('documentation-for-cplusplus', function () {
0 commit comments