jekyll-do - Publishing workflows for Jekyll from the command-line

jekyll-do provides a command-line publishing workflow for Jekyll sites. It gives you and easy way to create a draft, publish it, build, and deploy your site. It even has a workflow for syndicating your posts to third-party social sites like Twitter.

Use

Installation should be pretty straightforward if you already have Jekyll setup:

gem install jekyll-do

Now, you are ready to go.

Conifguration

If you want jekyll-do to open a new draft in an editor, you will need to make sure you have specified one of the standard environment variables for editors:

  • VISUAL

  • EDITOR

To check if they are set, try echoing each value out on the command line:

echo $VISUAL

If you get something back, you're good. If not you will want to add the following to your ~/.profile, ~/.bash_profile, or ~/.bashrc and then source the file you modified:

export VISUAL=vim
export EDITOR="$VISUAL"

Replace vim with whatever editor you use.

Workflows

To define a workflow you'll need to add a `workflows` section to your ~/.jekyll-do.yml file. Each workflow should be named so that it can be referenced later. Within the name, you add an ordered list of each step. Steps are commands that you would pass to jekyll-do. For example:

---
workflows:
  note:
    - "draft --no-edit --porcelain %{args}"
    - "publish --porcelain %{stdout_0}"
    - "build"
    - "deploy user@host.com:/path/to/site"
    - "syndicate --tweet %{stdout_1}"
    - "build"
    - "deploy user@host.com:/path/to/site"

Documentation

API Documentation is available at dustinboston.github.com/jekyll-do/rdoc/index.html

Credits

Author

Dustin Boston (dustin at dblogit dot com)

Copyright

Copyright © 2015 by Dusitn Boston

License

Distributed under the GPL, see LICENSE in the source distro

:include:jekyll-do.rdoc