Grunt plugin for pelican blog generator
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-pelican

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

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

grunt.loadNpmTasks('grunt-pelican');

The "pelican" task

Overview

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

grunt.initConfig({  
  pelican: {  
    options: {  
      contentDir: '../content', 
      outputDir: '/var/www/blog'
    }, 
    dev: { 
      configFile: 'settings.py' 
    },
    dist: { 
      configFile: 'pelicanconf.py' 
    }
  }
});

Options

options.contentDir

Type: String

Pelican's default value: .

Directory with all your ReST, Markdown, whatever else files.

options.configPath

Type: String

Pelican's default value: pelicanconf.py

Path to file with your pelican's settings.

options.outputDir

Type: String

Pelican's default value: output

Directory where pelican will put all your HTML, CSS etc. Usually your web server should point location to this dir.