Super simple flat documentation generator
npm install grunt-docu> Super simple flat documentation generator
~0.4.5If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a 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-docu --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-docu');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
docu: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
`$3
#### options.head
Type:
Default value: Path to custom head file
#### options.foot
Type:
Default value: Path to custom foot file
$3
#### Default Options
In this example, the default options are used to do something with whatever.
js
grunt.initConfig({
docu: {
options: {},
files: {
'dest/default_options': ['src/*/.html'],
},
},
});
`#### Custom Options
In this example, custom options are used to do something else with whatever else.
js
grunt.initConfig({
docu: {
myDocu: {
options: {
head: 'src/mydocu/head.html',
foot: 'src/mydocu/foot.html',
},
files: {
'dest/default_options': ['src/mydocu/*/.html'],
},
}
},
});
`$3
The table of contents element dispatches an event ('highlightchange'), everytime a new heading is highlighted. And passes the highlighted element under event.details. You can listen updates like this
js
document.querySelector('.docu-toc').addEventListener('highlightchange', function(event) {
console.log('Changed highlighted heading to:', event.details);
}
``