Flexible Lisp Blogware

Find a file

Brit Butler 7d9b0aa011 Flesh out the sketch a bit more and add some constraints.		2014-05-26 16:27:02 -04:00
docs	Add performance note to hacking docs.	2014-05-16 11:35:05 -04:00
examples	Update the post-receive script to pass the previous revision to Coleslaw.	2014-05-03 22:16:26 -04:00
plugins	Flesh out the sketch a bit more and add some constraints.	2014-05-26 16:27:02 -04:00
src	Push sketch slightly further up hill.	2014-05-26 16:27:02 -04:00
tests	I really need to write some more tests.	2014-05-01 18:53:06 -04:00
themes	Cleanup sitemap plugin a bit.	2014-05-08 11:37:10 -04:00
.gitignore	Implement DEPLOY, package updates, minor tweaks.	2012-08-19 00:29:33 -04:00
coleslaw.asd	I forgot to remove the conditions file from the defsystem.	2014-05-09 16:30:52 -04:00
LICENSE	Add BSD License file.	2013-01-29 10:18:26 -05:00
NEWS.md	Cleanup Twitter plugin and update docs a bit.	2014-05-09 11:54:22 -04:00
README.md	example sites update	2014-05-04 21:05:32 +02:00
TODO	Update templates to match posts->content.	2014-04-15 20:39:13 -04:00

README.md

coleslaw

Czeslaw Milosz was the writer-in-residence at UNC c. 1992. I used to see him all the time at the Hardback Cafe, always sitting at a two-top drinking coffee, reading, writing, eating chips and salsa. I remember a gentleness behind the enormous bushy eyebrows and that we called him Coleslaw. - anon

Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll.

Features

Git for storage
RSS and Atom feeds!
Markdown Support with Code Highlighting provided by colorize.
- Currently supports: Common Lisp, Emacs Lisp, Scheme, C, C++, Java, Python, Erlang, Haskell, Obj-C, Diff.
A Plugin API and plugins for...
- Static Pages
- Analytics via Google
- Comments via Disqus
- Hosting via Github Pages, Heroku, or Amazon S3
- Using LaTeX via Mathjax
- Using ReStructured Text
- Importing posts from Wordpress
- Sitemap generation
There is also a Heroku buildpack maintained by Jose Pereira.
Example sites:

Hacking

A core goal of coleslaw is to be both pleasant to read and easy to hack on and extend. If you want to understand the internals and bend coleslaw to do new and interesting things, I strongly encourage you to read the Hacker's Guide to Coleslaw.

Installation

This software should be portable to any conforming Common Lisp implementation but testing is primarily done on SBCL and CCL. Server side setup:

Setup git and create a bare repo as shown here.
Install Lisp (we recommend SBCL) and Quicklisp.
wget -c https://raw.github.com/redline6561/coleslaw/master/examples/example.coleslawrc -O ~/.coleslawrc # and edit as necessary
wget -c https://raw.github.com/redline6561/coleslaw/master/examples/example.post-receive -O your-blog.git/hooks/post-receive # and edit as necessary
chmod +x your-blog/.git/hooks/post-receive
Create or clone your blog repo locally. Add your server as a remote with git remote add prod git@my-host.com:path/to/repo.git
Point the web server of your choice at the symlink /path/to/deploy-dir/.curr/

Now whenever you push a new commit to the server, coleslaw will update your blog automatically! You may need to git push -u prod master the first time.

The Post Format

Coleslaw expects post files to be formatted as follows:

;;;;;
title: foo
tags: bar, baz
date: yyyy-mm-dd hh:mm:ss
format: html (for raw html) or md (for markdown)
;;;;;
your post

Theming

Two themes are provided: hyde and readable (based on bootswatch readable). Hyde is the default. A guide to creating themes for coleslaw lives here.