grunt-jekyll-post

Prompts questions in command line, then creates a Jekyll post template with the answers..

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-jekyll-post --save-dev

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

grunt.loadNpmTasks('grunt-jekyll-post');

The "jekyll_post" task

Overview

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

grunt.initConfig({
  jekyll_post: {
    questions: [
      {
        config: 'title',
        message: 'What would you like the title to be?',
        default: 'My Default Title'
      }
    ]
  },
});

Options

dist

Type: String
Default value: _drafts

The folder to which the output file will be written.

format

Type: String
Default value: md

The file format of the output file. Usually 'md' or 'markdown'.
Write just the extension, without the period

date

Type: Boolean
Default value: false

Include the current date in the output file's front-matter.

comments

Type: String or Object

Write a comment that will appear in the output file's front-matter, below any other content.
Example:

jekyll_post: {
  options: {
    comment: [
      'single comment',
      'anotha one'
    ]
  },
  questions: [
    {
      config: 'title',
      message: 'Title?',
      default: 'Your Default Title'
    }
  ]
}

You can also use a single line comment:

jekyll_post: {
  options: {
    comment: 'single comment'
  },
  questions: [
    {
      config: 'title',
      message: 'Title?',
      default: 'Your Default Title'
    }
  ]
}

Question Options

config

Type: String required

The name of the front-matter's variable (not the value). Example:

config: 'title'

Resulting front matter:

---
title: ANSWER
---

type

Type: String
Default value: input

The type of question you're asking:

• list: use arrow keys to pick one choice. Returns a string.
• checkbox: use arrow keys and space bar to pick multiple items. Returns an array.
• confirm: Yes/no. Returns a boolean.
• input: Free text input. Returns a string.
• password: Masked input. Returns a string.

Be sure to read the documentation for Inquiry, the project that enables command-line questions, for more details.

message

Type: String

The message that you want to see in the command line, prompting you to answer the question.

default

Type: String/Array/Boolan

The default value used when the user just hits enter without typing anything into it.
For list and checkbox questions, default will have to be the index for the default choice.
Example (the default will be Jason):

jekyll_post: {
  questions: [
    {
      config: 'title',
      message: 'Title?',
      default: 'Your Default Title'
    },
    {
      config: 'author',
      message: 'Pick an author',
      choices: ['Jason', 'Daniel'],
      default: 0
    }
  ]
}

choices

only for questions that have the type list or checkbox
Type: Array of Hashes

• name The label that is displayed in the UI.
• value optional Value returned. When not used the name is used instead.
• checked optional Choose the option by default. Only for checkbox.

Usage Examples

Add as many questions as you need, and they will be reflected in the output markdown file.

grunt.initConfig({
  jekyll_post: {
    option: {
      dist: '_post',
      format: 'markdown'
    },
    questions: [
      {
        config: 'title',
        message: 'Title?',
        default: 'Your Default Title'
      },
      {
        config: 'author',
        message: 'Author?',
        default: 'Your Default Author'
      }
    ]
  },
});

Release History

• 0.2.0 - 19 April 2016 - Moved questions property out of options and added new options.
• 0.1.3 - 17 April 2016 - Fixed up the docs
• 0.1.2 - 15 April 2016 - Task now finishes properly
• 0.1.1 - 15 April 2016 - Removed some unnecessary dependencies
• 0.1.0 - 15 April 2016 - First version