Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

mrcljx/grunt-liquid

Repository files navigation

grunt-liquid Build Status

Compile Liquid (node-liquid) templates.

Getting Started

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, install this plugin with this command:

npm install --save-dev grunt-liquid

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

grunt.loadNpmTasks('grunt-liquid');

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Documentation

See the grunt docs on how to configure tasks and more advanced usage.

Example

grunt.initConfig({
  liquid: {
    options: {
      includes: 'test/fixtures/inc',
      products: [
        {
          name: "Wonderflonium",
          price: "$9.99",
          description: "Great for building freeze rays!"
        }
      ]
    },
    pages: {
      files: [
        { expand: true, flatten: true, src: 'src/*.liquid', dest: 'dest/', ext: '.html' }
      ]
    }
  },
});

grunt.loadNpmTasks('grunt-liquid');
grunt.registerTask('default', ['liquid']);

Options

Options beside the following are treated as variables that are injected into the template.

includes

Type: Array or String
Default: ""

License

MIT © Marcel Jackwerth