An addon for middleman-blog that simplifies draft posts creation and publishing.
Ruby Gherkin HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
features
fixtures
lib
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
Gemfile.lock
Guardfile
LICENSE.txt
README.md
Rakefile
middleman-blog-drafts.gemspec

README.md

middleman-blog-drafts

NOTE: this project is no longer maintained. It breaks with recent versions of middleman and middleman-blog. None of the previous maintainers use middleman anymore.

That does not mean the code needs to rot away. If you see value in this project, have the technical skills and interest in maintaining it, please reach out!

Build Status

middleman-blog-drafts is an addon for middleman-blog that simplifies draft posts creation and publishing.

Install

If you're just getting started, install the required gems and generate a new blog project:

gem install middleman middleman-blog-drafts
middleman init MY_BLOG_PROJECT --template=blog

Then add middleman-blog-drafts to your Gemfile and activate the extension in your config.rb:

activate :drafts

Generating drafts

middleman draft 'My awesome new blog post'

Publishing drafts

middleman publish source/drafts/my-awesome-new-blog-post.markdown

Listing drafts on a page

<% if drafts.any? %>
  <ul>
    <% drafts.each do |draft| %>
      <li><%= link_to draft.title, draft.path %></li>
    <% end %>
  </ul>
<% end %>

As drafts won't be be available in the generated page by default, checking whether there are any is enough to decide whether to render the listing or not.

Configuration options

build: when true, the drafts will be available unconditionally. If not given, the drafts will be available in middleman's development mode and unavailable in middleman build.

This allows you to control the behaviour, for example if you have a preview instance of your blog. One way to do so would be to set it based on an environment variable:

activate :drafts do |drafts|
  drafts.build = true if ENV["SHOW_DRAFTS"]
end

This activates drafts in any environment where SHOW_DRAFTS is given and uses the default otherwise.

Frontmatter options

build can be overriden on a per-draft basis. For example if you want to make a draft available to a small audience for proofreading, you may force the build of that one draft with the following frontmatter:

---
title: "Example blog post"
build: true
---

Likewise if you configure build to true for your entire blog, you may still withhold single drafts from being built by setting build: false in the frontmatter.

Learn More

See the blog extension guide for detailed information on configuring and using the blog extension.

Credits

Most of the code was based on the middleman-blog gem itself, so many thanks to everyone that helped out with it.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request