{"id":19262739,"url":"https://github.com/documentationjs/grunt-documentation","last_synced_at":"2025-04-21T18:31:13.817Z","repository":{"id":57254966,"uuid":"47537413","full_name":"documentationjs/grunt-documentation","owner":"documentationjs","description":"Use Grunt with documentation to generate great documentation for your JavaScript projects.","archived":false,"fork":false,"pushed_at":"2018-11-30T03:46:19.000Z","size":1369,"stargazers_count":4,"open_issues_count":9,"forks_count":11,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-15T20:22:14.416Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-12-07T07:50:32.000Z","updated_at":"2021-05-13T15:01:25.000Z","dependencies_parsed_at":"2022-08-31T08:31:44.958Z","dependency_job_id":null,"html_url":"https://github.com/documentationjs/grunt-documentation","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgrunt-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgrunt-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgrunt-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fgrunt-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/documentationjs","download_url":"https://codeload.github.com/documentationjs/grunt-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250110899,"owners_count":21376551,"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-11-09T19:33:18.261Z","updated_at":"2025-04-21T18:31:13.212Z","avatar_url":"https://github.com/documentationjs.png","language":"JavaScript","readme":"# grunt-documentation\n\n[![Circle CI](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master)\n[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/grunt-documentation.svg)](https://greenkeeper.io/)\n\nUse [Grunt](http://gruntjs.com/) with [documentation](https://github.com/documentationjs/documentation)\nto generate great documentation for your JavaScript projects.\n\n## Getting Started\nThis plugin requires Grunt `\u003e=0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-documentation --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-documentation');\n```\n\n## The \"documentation\" task\n\n### Overview\nIn your project's Gruntfile, add a section named `documentation` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n    documentation: {\n        default: {\n            files: [{\n                \"expand\": true,\n                \"cwd\": \"src\",\n                \"src\": [\"**/*.js\"]\n            }],\n            options: {\n                destination: \"docs\"\n            }\n        },\n    }\n});\n```\n\n### Options\n\n#### options.destination\nType: `String`\n\nThe destination folder for the generated docs.\n\n#### options.format\nType: `String`\nDefault value: `'html'`\n\nEither `'html'`, `'md'`, `'json'`, or `'docset'`.\n\n#### options.filename\nType: `String`\n\nCustom filename for md or json output.\n\n#### options.access\nType: `Array`\nDefault value: `['protected', 'public', 'undefined']`\n\nInclude only comments with a given access level, out of `private`, `protected`, `public` and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.\n\n#### options.order\nType: `Array`\nDefault value: `[]`\n\nAn array defining explicit sort order.\n\n#### options.theme\nType: `String`\n\nPath to a custom theme.\n\n#### options.name\nType: `String`\n\nA custom project name to display in the generated documentation.\n\n#### options.version\nType: `String`\n\nA custom version string to display in the generated documentation.\n\n## Contributing\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint your code using [Grunt](http://gruntjs.com/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fgrunt-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocumentationjs%2Fgrunt-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fgrunt-documentation/lists"}