grunt-hexo

A Grunt wrapper for the Hexo static site blog framework

Getting Started

This plugin requires Grunt >=0.4.5

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

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

grunt.loadNpmTasks('grunt-hexo');

The "hexo" task

Overview

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

grunt.initConfig({
  hexo: {
    clean: {
      options: {
        root: '/',
        cliCmd: 'clean'
      }
    },
    generate: {
      options: {
        root: '/',
        cliCmd: 'generate'
      }
    },
  },
});

Then define your task to run. This is an example to define a default task to always clean and generate:

grunt.registerTask('default', ['hexo:clean', 'hexo:generate']);

Options

options.root

Type: String Default value: '/'

A valid path within your project directory that contains your Hexo site. It may be the project directory itself or any subdirectory. That option tells grunt-hexo where the Hexo installation and module can be found.

options.cliCmd

Type: String Default value: generate

A valid command you want to run as a task. Can be one of

• clean
• generate

Further Notes

Currently, this is very basic. It only runs the "generate" and "clean" commands from Hexo, which was enough for my use at the moment. I'm planning to add more commands and options until at some point the whole API of Hexo will be covered (hopefully). PRs are welcome.

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.