# grunt-modulate > Templating HTML module. ## Getting Started This plugin requires Grunt `~0.4.1` 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-modulate --save-dev ``` Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: ```js grunt.loadNpmTasks('grunt-modulate'); ``` *This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that [you upgrade](http://gruntjs.com/upgrading-from-0.3-to-0.4), but in case you can't please use [v0.3.2](https://github.com/gruntjs/grunt-contrib-less/tree/grunt-0.3-stable).* ## Modulate task ### Overview _Run this task with the `grunt modulate` command._ Task targets, files and options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide. ### Options #### relativate Type: `Boolean` Default value: `false` Convert to relative path, or not. #### template Type: `RegExp` Default value: `/([\t\ ]*?)(()([\S\s]*?)())/g` Regular expression for validating template tags. #### tagslink Type: `RegExp` Default value: `/(href=|src=)("|')(.*?)("|')/g` Regular expression for validating url type and url. #### exclude Type: `Array` Default value: `[/^#/, /^mailto:/, /^(\/|http|https|ftp):\/\//]` Regular expression list for validating null link (hash link), mail link, absolute path. ### Usage Examples #### Sample directory tree ```shell . ├── Gruntfile.js ├── node_modules ├── package.json └── test ├── 1 │ ├── sub │ │ ├── test1.html │ │ └── test2.html │ ├── test1.html │ └── test2.html ├── 2 │ ├── sub │ │ ├── test1.html │ │ └── test2.html │ ├── test1.html │ └── test2.html └── assets ├── html │ └── modules │ └── _src │ ├── _mod-bar.html │ ├── _mod-baz.html │ └── _mod-foo.html └── img └── img.gif ``` #### Gruntfile.js ```js modulate: { modules: { options: { relativate: true }, files: [ { expand: true, cwd: 'test', src: ['**/*.html', '!**/_src/*.html'], dest: 'test' } ] } } ``` #### Module file e.g. test/assets/html/module/_src/_mod-foo.html If you want to convert to relative path, href attribute value must be **site-root relative path**. ```html

``` #### target file before running task e.g. test/1/sub/test1.html Module path must be **site-root relative path**. ```html ``` #### target file after running task e.g. test/1/sub/test1.html Module path must be **site-root relative path**. ```html

``` ## Inspired by [Modullatte](https://github.com/mach3/modullatte) by mach3 ## Release History * 2013-05-17 v0.1.0 Work in progress, not yet officially released.