⚠️ This is a fork of shovon/grunt-harp: A grunt task for the Harp server. that is only semi-maintained and do not recommend relying on this in production.
A Grunt task for either running a Harp server, or compile your site using Harp.
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:
yarn add grunt-harp
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-harp');
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/'
}
}
});
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.
Type: Number
Default value: 9000
The server port that Harp should use for the site.
Type: String
Default value: './'
The directory of which to get the source files from.
Type: String
Default value: build
The directory of which to store the generated site.
grunt.initConfig({
harp: {
server: {
server: true
},
dist: {}
}
});
grunt.initConfig({
harp: {
server: {
server: true,
source: 'src'
},
dist: {
source: 'src',
dest: 'build'
}
}
});
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.