Skip to content

bryanthompson/milksteak

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Milksteak is a little experiment in tiny-cms-land. My goal with it is to build the minimum structure necessary and keep it as far from anything like rails as possible, with minimum requirements, fast tests, and simple structure. Expect the project to change rather dramatically as I add to it, feel free to fork and do whatever you like, and as always, pull requests are very welcome.

Install

gem install milksteak 
gem 'milksteak' # if using bundler

Configuration

In your site's config, make sure milksteak is being required, then set your milk_root:

# This would create and use a milk/ folder in the root of your site.
Milksteak::Admin.set :milk_root, File.join(File.dirname(__FILE__), "milk")

If you plan on using the Milksteak::Admin module, include it in your rack cascade.
Here's an example, but you might need to figure out an alternative way if using rails or some other setup:

run Rack::Cascade.new [Sinatra::Application, Milksteak::Admin]

Usage

There are several ways to use Milksteak for content management. The simplest example would be to include an editable area on a random page. Let's say we want some sidebar text to be editable.

views/sidebar.erb

<%= Milksteak::Page.render("sidebar-content") %>

milk/pages/sidebar-content.yml

---
yml_variables: can go here
and_then_you: can use them below in content.
---

Here's the sidebar content. I can use the {{yml_variables}} and such.

Roadmap

  • Blog/News engine
  • Photo galleries
  • Flexible collection types for data lists and content types (kinda hard to bullet-point intention here)
  • Support for storage back-ends rather than YML, if necessary
  • Tie into Tonic CMS (v3) API
  • Dynamic page routes (currently pages are treated as content fragments)
  • ... Contact me with your requests and ideas, or fork and add your own

License

Milksteak is released under the MIT license and is copyright (c) 2012 Bryan Thompson

About

super tiny ruby-based cms that can be added to any ruby project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published