Jekyll::Compose

Streamline your writing in Jekyll with some commands.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-compose', group: [:jekyll_plugins]

And then execute:

$ bundle

Usage

After you have installed (see above), run

bundle exec jekyll help

Listed in help you will see new commands available to you:

  draft      # Creates a new draft post with the given NAME
  post       # Creates a new post with the given NAME
  publish    # Moves a draft into the _posts directory and sets the date
  unpublish  # Moves a post back into the _drafts directory
  page       # Creates a new page with the given NAME
  rename     # Moves a draft to a given NAME and sets the title
  compose    # Creates a new file with the given NAME

Create your new page using:

    $ bundle exec jekyll page "My New Page"

Create your new post using:

    $ bundle exec jekyll post "My New Post"
    # or specify a custom format for the date attribute in the yaml front matter
    $ bundle exec jekyll post "My New Post" --timestamp-format "%Y-%m-%d %H:%M:%S %z"

    # or by using the compose command
    $ bundle exec jekyll compose "My New Post"

    # or by using the compose command with post specified
    $ bundle exec jekyll compose "My New Post" --post

    # or by using the compose command with the posts collection specified
    $ bundle exec jekyll compose "My New Post" --collection "posts"

Create your new draft using:

    $ bundle exec jekyll draft "My new draft"

    # or by using the compose command with draft specified
    $ bundle exec jekyll compose "My new draft" --draft

    # or by using the compose command with the drafts collection specified
    $ bundle exec jekyll compose "My new draft" --collection "drafts"

Rename your draft using:

$ bundle exec jekyll rename _drafts/my-new-draft.md "My Renamed Draft"

# or rename it back
$ bundle exec jekyll rename _drafts/my-renamed-draft.md "My new draft"

Publish your draft using:

    $ bundle exec jekyll publish _drafts/my-new-draft.md

    # or specify a specific date on which to publish it
    $ bundle exec jekyll publish _drafts/my-new-draft.md --date 2014-01-24
    # or specify a custom format for the date attribute in the yaml front matter
    $ bundle exec jekyll publish _drafts/my-new-draft.md --timestamp-format "%Y-%m-%d %H:%M:%S %z"

Rename your post using:

$ bundle exec jekyll rename _posts/2014-01-24-my-new-draft.md "My New Post"

# or specify a specific date
$ bundle exec jekyll rename _posts/2014-01-24-my-new-post.md "My Old Post" --date "2012-03-04"

# or specify the current date
$ bundle exec jekyll rename _posts/2012-03-04-my-old-post.md "My New Post" --now

Unpublish your post using:

    $ bundle exec jekyll unpublish _posts/2014-01-24-my-new-draft.md

Create your new file in a collection using:

    $ bundle exec jekyll compose "My New Thing" --collection "things"

Configuration

To customize the default plugin configuration edit the

jekyll_compose

auto-open new drafts or posts in your editor

  jekyll_compose:
    auto_open: true

and make sure that you have

EDITOR

VISUAL

JEKYLL_EDITOR

sh
export JEKYLL_EDITOR=atom

JEKYLL_EDITOR

EDITOR

VISUAL

VISUAL

EDITOR

Set default front matter for drafts and posts

If you wish to add default front matter to newly created posts or drafts, you can specify as many as you want under

default_front_matter

jekyll_compose:
  default_front_matter:
    drafts:
      description:
      image:
      category:
      tags:
    posts:
      description:
      image:
      category:
      tags:
      published: false
      sitemap: false

This will also auto add: - The creation timestamp under the

date

title

For collections, you can add default front matter to newly created collection files using

default_front_matter

things

jekyll_compose:
  default_front_matter:
    things:
      description:
      image:
      category:
      tags:

Contributing

1. Fork it ( http://github.com/jekyll/jekyll-compose/fork )
2. Create your feature branch (

   git checkout -b my-new-feature

   )
3. Run the specs and our linter (

   script/cibuild

   )
4. Commit your changes (

   git commit -am 'Add some feature'

   )
5. Push to the branch (

   git push origin my-new-feature

   )
6. Create new Pull Request

Submitting a Pull Request based on an existing proposal

When submitting a pull request that uses code from an unmerged pull request, please be aware of the following: * Changes proposed in the older pull request is still the original author's property. Moving forward from where they left it means that you're a

co-author