marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Flexible Lisp Blogware
483 commits 10 branches 0 tags 1.6 MiB
Common Lisp 90.3%
CSS 7.5%
Shell 2.2%
Find a file
Brit Butler 99e87c061f Add some error-handling notes.
2014-09-05 17:06:41 -04:00
docs Add some error-handling notes. 2014-09-05 17:06:41 -04:00
examples Tentatively factor deploy method into git-hook plugin. TODO follows... 2014-09-05 17:06:41 -04:00
plugins Tentatively factor deploy method into git-hook plugin. TODO follows... 2014-09-05 17:06:41 -04:00
src Tentatively factor deploy method into git-hook plugin. TODO follows... 2014-09-05 17:06:41 -04:00
tests Tentatively factor deploy method into git-hook plugin. TODO follows... 2014-09-05 17:06:41 -04:00
themes Fix buglet in readable theme's post template. 2014-09-04 09:09:36 -04:00
.gitignore Implement DEPLOY, package updates, minor tweaks. 2012-08-19 00:29:33 -04:00
coleslaw.asd Bugfix: Feed should be an abstract class. 2014-09-05 17:06:41 -04:00
LICENSE Add BSD License file. 2013-01-29 10:18:26 -05:00
NEWS.md Last minute NEWS tweak to sneak this into 0.9.5/Quicklisp June 2014. 2014-06-13 09:51:02 -04:00
README.md fix link to chiptheglasses 2014-08-22 14:01:29 -04:00
TODO Update templates to match posts->content. 2014-04-15 20:39:13 -04:00

README.md

coleslaw

coleslaw logo

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 is Flexible Lisp Blogware similar to Frog, Jekyll, or Hakyll.

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...

  • 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:

  1. Setup git and create a bare repo as shown here.
  2. Install Lisp (we recommend SBCL) and Quicklisp.
  3. wget -c https://raw.github.com/redline6561/coleslaw/master/examples/example.coleslawrc -O ~/.coleslawrc # and edit as necessary
  4. wget -c https://raw.github.com/redline6561/coleslaw/master/examples/example.post-receive -O your-blog.git/hooks/post-receive # and edit as necessary
  5. chmod +x your-blog/.git/hooks/post-receive
  6. 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
  7. 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.