Giter Club home page Giter Club logo

grunt-harp's Introduction

grunt-harp

A grunt task for either running a Harp server, or compile your site using harp.

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-harp');

The "harp" task

Overview

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

grunt.initConfig({
  harp: {
    server: {
      server: true,
      source: 'src'
    },
    dist: {
      source: 'src',
      dest: 'build'
    }
  },
})

Options

options.server

Type: Boolean
Default value: false

Used to determine whether or not to spawn a server. If set to true, a server will be spawned. However, a static site won't be generated.

options.port

Type: Number
Default value: 9000

The server port that Harp should use for the site.

options.source

Type: String
Default value: './'

The directory of which to get the source files from.

options.dest

Type: String
Default value: build

The directory of which to store the generated site.

Usage Examples

Default Options

grunt.initConfig({
  harp: {
    server: {
      server: true
    },
    dist: {}
  },
})

Custom Options

grunt.initConfig({
  harp: {
    server: {
      server: true,
      source: 'src'
    },
    dist: {
      source: 'src',
      dest: 'build'
    }
  },
})

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.

grunt-harp's People

Contributors

jansepar avatar kennethormandy avatar shovon avatar sintaxi avatar suisho avatar whitef0x0 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.