https://github.com/oxyc/grunt-docs-landing
A grunt plugin to generate doc landing pages
https://github.com/oxyc/grunt-docs-landing
Last synced: about 1 year ago
JSON representation
A grunt plugin to generate doc landing pages
- Host: GitHub
- URL: https://github.com/oxyc/grunt-docs-landing
- Owner: oxyc
- License: mit
- Created: 2012-11-14T11:41:16.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-11-14T11:46:08.000Z (over 13 years ago)
- Last Synced: 2025-02-10T06:24:33.297Z (over 1 year ago)
- Language: JavaScript
- Size: 105 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-docs-landing
Grunt plugin to generate a documentation landing page from the output of
other generators.
## Getting started
Install the plugin (not in npm yet) with `npm install git@github.com:oxyc/grunt-docs-landing.git`
Load the task in in your Gruntfile.js using:
```javascript
grunt.loadNpmTasks('grunt-docs-landing');
```
## Configuration
```javascript
docspage: {
sections: {
js: 'docs/js/*.html', // Files will be listed under js
php: 'docs/php/*.html' // Files will be listed under php
},
options: {
out: 'docs/index.html', // Output file
template: 'docs/layout/template.jst', // Template file
}
}
```
The template will be passed a `sections` array which looks something similar to
this:
```
sections = [{
heading: 'js documentation',
files: [{
path: 'docs/js/app.html',
name: 'app'
}, {
path: 'docs/js/main.html',
name: 'main'
}]
}];
```
Check out the example to get started.
## License
MIT