0.1.1 • Published 8 years ago

grunt-joomlaindexer v0.1.1

Weekly downloads
-
License
-
Repository
github
Last release
8 years ago

grunt-joomlaindexer

Puts index.html files in every directory found.

Getting Started

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-joomlaindexer --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-joomlaindexer');

The "joomlaindexer" task

Overview

In your project's Gruntfile, add a section named joomlaindexer to the data object passed into grunt.initConfig().

grunt.initConfig({
  joomlaindexer: {
    your_target: ['dir1/', 'dir2/'],
    options: {
      filename: 'index.html',
      content: '<!DOCTYPE html><title></title>\n'
    }
  },
});

Options

options.filename

Type: String Default value: index.html

Specify the name of the filename that has to be created.

options.content

Type: String Default value: <!DOCTYPE html><title></title>\n

The content that the newly created files have.

Usage Examples

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.

Release History

0.1.0 (19-02-2016)

Initial plugin. Adds a file to every subdirectory found.

0.1.1

8 years ago

0.1.0

8 years ago