Skip to content

matt-hh/middleman-blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

middleman-blog

Create a blog with Middleman

Features

TODO

  • test suite

  • better documentation

  • installer/generator

  • more helpers

  • more build-in features (releated posts, tags etc.)

Usage

Example: github.com/matt-hh/middleman-blog-example

  1. Install

    gem install middleman-blog
    

    Additionally you need one of the following gems for your post templates: Kramdown, Maruku, RedCloth, BlueCloth, RDiscount …

  2. Create your project

    mm-init your-middleman-project
  3. Create config/blogs.yml with default values

    blog:
      title: My Blog
      author: your name
      mail: your mail
      whatever: a value
    another-blog:
      title: My second Blog

    Yes, you can define default values for more than one blog…

  4. Create layout files:

    blog_index.haml:

    %h1= current_blog_value('title')
    = yield

    blog_post.haml:

    %h1= current_post_value('title')
    = yield
  5. Activate feature in config.rb

    require "middleman-blog"
    activate :blog_engine
    
    page "/blog/index.html", :layout => :blog_index, :layout_engine => 'haml'
    page "/blog/*", :layout => :blog_post, :layout_engine => 'haml'
    
    page "/another-blog/index.html", :blog_post => :blog_index, :layout_engine => 'haml'
    page "/another-blog/*", :blog_post => :blog_post, :layout_engine => 'haml'
    
  6. Create directories in your source folder

    mkdir blog
    mkdir my-second-blog
    

    In these folders you can create your posts.

    blog/my-first-post.html.md

    title: Title of my first post
    date: 2011-06-05
    ----
    
    My first blog post...

    Important: 2 newlines between “—-” and “My first…”

Metadata

  • “—-nnn” separates the metadata from your post data.

  • metadata supports ERB

  • you can define whatever you want

  • special keys for blogs.yml: sort_by: name of another key (default is date) sort_direction: normal | reverse (default is reverse)

  • special keys for yaml header: date: default is mtime for template file

Helper methods

  • current_blog

  • current_blog_meta(key) or current_blog

  • current_post

  • current_post_meta(key) or current_post

  • next_post

  • prev_post

  • current_blog_ident

  • current_post_ident

  • current_post_index

Examples

  • Link to the next post

    link_to next_post['title'], next_post['link']
    
  • List of 10 last posts

    %ul
      - current_blog["posts"][0,10].each do |post|
        %li= link_to post['title'], post['link']

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages