Skip to content

Instantly share code, notes, and snippets.

@dannygarcia

dannygarcia/grunt.js

Created September 20, 2012 02:39
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save dannygarcia/3753650 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save dannygarcia/3753650 to your computer and use it in GitHub Desktop.
Download ZIP
Sample grunt-jekyll grunt.js
Raw
readme.markdown

Sample grunt-jekyll grunt.js

  1. Use the following folder structure
[root]
    |-- templates/
        |-- index.html (Jekyll templates)
    |-- prod/
    |-- dev/
    |-- _config.yml (optional)

  1. Add the grunt.js file below at the root of your project.

  2. Install the grunt-jekyll gruntmodule next to your project's grunt.js gruntfile with: npm install grunt-jekyll.

  3. Run the grunt jekyll commands:

  • grunt jekyll or grunt jekyll:server to start a server that watches the templates directory.

  • grunt jekyll:dev to process files to the dev directory.

  • grunt jekyll:prod to process files to the prod directory.

Of course, everything here is fully configurable to your liking.

Raw
grunt.js
// Sample grunt-jekyll grunt.js file
// https://github.com/dannygarcia/grunt-jekyll
/*global module:false*/
module.exports = function(grunt) {
// Project configuration.
grunt.initConfig({
jekyll: {
server : {
src : 'templates',
dest: 'dev',
server : true,
server_port : 8000,
auto : true
},
dev: {
src: 'templates',
dest: 'dev'
},
prod: {
src: 'templates',
dest: 'prod'
}
},
watch: { // for development run 'grunt watch'
jekyll: {
files: ['templates/*.html'],
tasks: ['jekyll:dev']
}
}
});
// Default task. Run standard jekyll server.
grunt.registerTask('default', 'jekyll:server');
// plugin tasks
grunt.loadNpmTasks('grunt-jekyll');
};
@YoungElPaso
Copy link

YoungElPaso commented Mar 5, 2014

@tomireland, I think this sample file is out of date. Or at least I don't think the syntax for the server options are set quite right. Yeah, in fact the option "server: true" needs to be "serve: true" with the current version of grunt-jekyll, and should be wrapped in an "options" object : eg options : {serve: true}. Also the rest of the options are just that, options and the default jekyll build and serve will work fine.

@liquidvisual
Copy link

liquidvisual commented May 13, 2014

Any chance of an update? Would love to get this working with Jekyll 2.0.2

@prbaron
Copy link

prbaron commented Jun 18, 2014

@liquidvisual, I made it works by modifying these lines, allowing to the code of the plugin.

jekyll: {
    server : {
        options : {
            server : true,
            server_port : 8000,
            auto : true
        }
    }
}

@ezze
Copy link

ezze commented Oct 28, 2014

I was unable to run a server with Jekyll 2.4.0 and plugin version 0.4.2 on Ubuntu 14.04 LTS. After looking at the source code of the Grunt task I got that it must be serve option instead of server.

server: {
    options: {
        serve: true,
        port: 8000,
        auto: true
    }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment