{"id":13659432,"url":"https://github.com/documentationjs/gulp-documentation","last_synced_at":"2025-04-10T11:09:33.124Z","repository":{"id":57257376,"uuid":"33013026","full_name":"documentationjs/gulp-documentation","owner":"documentationjs","description":"Use gulp with documentation to generate great documentation for your JavaScript projects.","archived":false,"fork":false,"pushed_at":"2018-11-30T03:46:01.000Z","size":89,"stargazers_count":64,"open_issues_count":9,"forks_count":14,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-24T09:52:55.490Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://documentation.js.org/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/documentationjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-27T22:59:09.000Z","updated_at":"2024-11-04T13:16:48.000Z","dependencies_parsed_at":"2022-09-08T20:41:47.007Z","dependency_job_id":null,"html_url":"https://github.com/documentationjs/gulp-documentation","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgulp-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgulp-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgulp-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgulp-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/documentationjs","download_url":"https://codeload.github.com/documentationjs/gulp-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247908620,"owners_count":21016473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T05:01:08.620Z","updated_at":"2025-04-10T11:09:33.108Z","avatar_url":"https://github.com/documentationjs.png","language":"JavaScript","readme":"# gulp-documentation\n\n[![Circle CI](https://circleci.com/gh/documentationjs/gulp-documentation.svg?style=shield)](https://circleci.com/gh/documentationjs/gulp-documentation)\n[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/gulp-documentation.svg)](https://greenkeeper.io/)\n\nUse [gulp](http://gulpjs.com/) with\n[documentation](https://github.com/documentationjs/documentation)\nto generate great documentation for your JavaScript projects.\n\n## Installation\n\n```sh\n$ npm install --save-dev gulp-documentation\n```\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n### documentation\n\nDocumentation stream intended for use within the gulp system.\n\n**Parameters**\n\n-   `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`)\n-   `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)\n    -   `options.filename` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** custom filename for md or json output\n-   `formatterOptions` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** output options - same as given to documentation\n    -   `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\n\n**Examples**\n\n```javascript\nvar gulpDocumentation = require('gulp-documentation');\nvar gulp = require('gulp');\n//  Out of the box, you can generate JSON, HTML, and Markdown documentation\ngulp.task('documentation-readme-example', function () {\n  // Generating README documentation\n  return gulp.src('./index.js')\n    .pipe(gulpDocumentation('md'))\n    .pipe(gulp.dest('md-documentation'));\n});\n\n// Generating a pretty HTML documentation site\ngulp.task('documentation-html-example', function () {\n  return gulp.src('./index.js')\n    .pipe(gulpDocumentation('html'))\n    .pipe(gulp.dest('html-documentation'));\n});\n\n// Generating raw JSON documentation output\ngulp.task('documentation-json-example', function () {\n  return gulp.src('./index.js')\n    .pipe(gulpDocumentation('json'))\n    .pipe(gulp.dest('json-documentation'));\n});\n\n// Generate documentation for multiple files using normal glob syntax.\n// Note that this generates one documentation output, so that it can\n// easily cross-reference and use types.\ngulp.task('documentation-multiple-files', function () {\n  return gulp.src('./src/*.js')\n    .pipe(gulpDocumentation('md'))\n    .pipe(gulp.dest('md-documentation'));\n});\n\n\n// If you're using HTML documentation, you can specify additional 'name'\n// and 'version' options\ngulp.task('documentation-html-options', function () {\n  return gulp.src('./src/*.js')\n    .pipe(gulpDocumentation('html', {}, {\n      name: 'My Project',\n      version: '1.0.0'\n    }))\n    .pipe(gulp.dest('html-documentation'));\n});\n\n// Document non-JavaScript files with JSDoc comments using polyglot: true\ngulp.task('documentation-for-cplusplus', function () {\n  return gulp.src('./src/*.cpp')\n    .pipe(gulpDocumentation('html', { polyglot: true }, {\n      name: 'My Project',\n      version: '1.0.0'\n    }))\n    .pipe(gulp.dest('html-documentation'));\n});\n```\n\nReturns **[stream.Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform)** \n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fgulp-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocumentationjs%2Fgulp-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fgulp-documentation/lists"}