Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/couto/grunt-simple-dox
Simply run dox
https://github.com/couto/grunt-simple-dox
Last synced: about 8 hours ago
JSON representation
Simply run dox
- Host: GitHub
- URL: https://github.com/couto/grunt-simple-dox
- Owner: Couto
- Created: 2013-07-21T19:42:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-12-01T10:31:59.000Z (almost 9 years ago)
- Last Synced: 2024-11-14T12:08:54.589Z (5 days ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# grunt-simple-dox
> Simply run [dox](https://github.com/visionmedia/dox) to generate the json files
## Getting Started
This plugin requires Grunt.
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-simple-dox --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-simple-dox');
```
## The "simple_dox" task
### Overview
In your project's Gruntfile, add a section named `simple_dox` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
simple_dox: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```
### Options
Please check [dox](https://github.com/visionmedia/dox) options.
### Usage Examples
#### Default Options
In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
```js
grunt.initConfig({
simple_dox: {
options: {},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```
#### Custom Options
In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
```js
grunt.initConfig({
simple_dox: {
options: {
raw: true,
},
files: {
'dest/default_options': ['src/testing', 'src/123'],
},
},
})
```
## 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 and test your code using [Grunt](http://gruntjs.com/).
## Release History
_(Nothing yet)_
## License
Copyright (c) 2013 Luis Couto. Licensed under the MIT license.