https://github.com/documentationjs/grunt-documentation
Use Grunt with documentation to generate great documentation for your JavaScript projects.
https://github.com/documentationjs/grunt-documentation
Last synced: 12 months ago
JSON representation
Use Grunt with documentation to generate great documentation for your JavaScript projects.
- Host: GitHub
- URL: https://github.com/documentationjs/grunt-documentation
- Owner: documentationjs
- License: mit
- Created: 2015-12-07T07:50:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T03:46:19.000Z (over 7 years ago)
- Last Synced: 2025-03-15T20:22:14.416Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.31 MB
- Stars: 4
- Watchers: 3
- Forks: 11
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-documentation
[](https://circleci.com/gh/documentationjs/grunt-documentation/tree/master)
[](https://greenkeeper.io/)
Use [Grunt](http://gruntjs.com/) with [documentation](https://github.com/documentationjs/documentation)
to generate great documentation for your JavaScript projects.
## Getting Started
This plugin requires Grunt `>=0.4.0`
If 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:
```shell
npm install grunt-documentation --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-documentation');
```
## The "documentation" task
### Overview
In your project's Gruntfile, add a section named `documentation` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
documentation: {
default: {
files: [{
"expand": true,
"cwd": "src",
"src": ["**/*.js"]
}],
options: {
destination: "docs"
}
},
}
});
```
### Options
#### options.destination
Type: `String`
The destination folder for the generated docs.
#### options.format
Type: `String`
Default value: `'html'`
Either `'html'`, `'md'`, `'json'`, or `'docset'`.
#### options.filename
Type: `String`
Custom filename for md or json output.
#### options.access
Type: `Array`
Default value: `['protected', 'public', 'undefined']`
Include only comments with a given access level, out of `private`, `protected`, `public` and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.
#### options.order
Type: `Array`
Default value: `[]`
An array defining explicit sort order.
#### options.theme
Type: `String`
Path to a custom theme.
#### options.name
Type: `String`
A custom project name to display in the generated documentation.
#### options.version
Type: `String`
A custom version string to display in the generated documentation.
## Contributing
In 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/).