README.md

grunt-surge

Easily deploy to a CDN with Grunt.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven’t used Grunt before, consider taking a look at the stand-alone version of Surge.

Otherwise, be sure to check out the Grunt’s Getting Started guide. 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 --save-dev grunt-surge

Usage

Next, add it to your project’s Gruntfile.js:

// Gruntfile.js

module.exports = function(grunt) {
  grunt.initConfig({
    surge: {
      'my-project-name': {
        options: {
          project: 'dist/',
          domain: 'my-project-name.surge.sh'
        }
      }
    }
  });

  grunt.loadNpmTasks('grunt-surge');
};

Now you can register a Grunt task to deploy the project to the specified domain:

grunt.registerTask('deploy', ['surge']);

Examples

• @sillygwailo’s Gruntfile will publish to Surge with a notification
• @kennethormandy’s Gruntfile for Style and Class will compile a Jekyll site and then publish to Surge
• @davethegr8’s starter pack Gruntfile uses Harp to serve projects locally and automatically precompile Markdown, Sass, CoffeeScript, and more
• Your Gruntfile here? Just open an issue.

Contributing

Thanks for considering contributing! There’s information about how to get started here.

License

The MIT License (MIT)

Copyright © 2014–2015 Chloi Inc.