The plugin creates an index contents file with a list of html files in your project
This plugin requires Grunt ~0.4.5
If 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:
npm install grunt-list-page --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-list-page');
In your project's Gruntfile, add a section named list_page
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
list_page: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Type: String
Default value: 'template.html'
Contents file template path.
Type: String
Default value: 'Mainpage'
Contents file title.
Type: String
Default value: '<li><a href="%href%">%name%</a></li>'
Template for item in contents list.
grunt.initConfig({
list_page: {
options: {},
files: {
'index_file.html': ['src/*.html', 'src/*.htm'],
},
},
});
grunt.initConfig({
list_page: {
options: {
title: 'My best title',
},
files: {
'index_file.html': ['src/*.html', 'src/*.htm'],
},
},
});
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.
(Nothing yet)