Sha256: ee7d4ce22e14bf06b7a6b3844635e7fc22ecc5138b58b4151495bae6097144eb

Contents?: true

Size: 1.55 KB

Versions: 1

Compression:

Stored size: 1.55 KB

Contents

# Low Voltage

If you've heard of [High Voltage](https://github.com/thoughtbot/high_voltage) then all you need to know is we're like that, but for blogs.

High Voltage allows you to very easily setup static pages in your Rails app without having to setup extra controllers and actions. You put a page of content in a pages folder under your views and it shows up on your website as `/pages/blah`. This is the same concept, only with a blog format. You write a blog post, add some metadata, drop it in a folder, and voila your blog has a new post.

I wrote Low Voltage because I used [Nesta](https://github.com/gma/nesta) and really liked it, but then wanted to add more Rails to it. Instead of going through mounting it in my app, I found High Voltage and re-tooled it to work as a blog platform as well.

## Install

Add the following line to your Gemfile:

    gem 'low_voltage'

## Basic Usage

1. Add a directory called `posts` to your views folder, all your blog posts will go here.
2. Publish a new blog post by creating a new markdown file similar to the example below:
``` 
    ---
    title: Secondary Title
    date: June 28 2012
    author: Adam Michel
    ---

    Hello World
    ===========
    Here is my first post!
```
3. Run `rails server` and browse to [localhost:3000/blog](http://localhost:3000/blog) to see your new Markdown powered blog.

## TODO

* Add some basic configuration options to override the defaults.
* Add an RSS feed.
* I should probably get in the habbit of writing tests...

## Copyright

Copyright (c) 2012 Adam Michel. See LICENSE for details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
low_voltage-0.0.3 README.md