Flexible Lisp Blogware. Fork for personal use. Mirrored from https://github.com/kingcons/coleslaw originally.

Brit Butler c706964880 Add exit function and use it in post-receive script. Fixes Issue #13. vor 12 Jahren
docs 1ee5402179 Docs update and package tweaks. vor 12 Jahren
examples c706964880 Add exit function and use it in post-receive script. Fixes Issue #13. vor 12 Jahren
plugins e1a1ca75cf Minor cleanup to S3 plugin. vor 12 Jahren
src c706964880 Add exit function and use it in post-receive script. Fixes Issue #13. vor 12 Jahren
tests 8c0b1f8697 Rework ASDs, add stub md+rst plugins, docs script, and stub tests. vor 13 Jahren
themes cc2700b817 Text is the universal interface. vor 12 Jahren
.gitignore a698389c42 Implement DEPLOY, package updates, minor tweaks. vor 13 Jahren
LICENSE 499453f622 Add BSD License file. vor 12 Jahren
NEWS.md c706964880 Add exit function and use it in post-receive script. Fixes Issue #13. vor 12 Jahren
README.md 9f72bff710 Slight README tweaks. vor 12 Jahren
TODO c169581485 TODO updates. vor 12 Jahren
coleslaw.asd 8592cad324 Release: Version 0.8! NEWS tells the story. vor 12 Jahren
gen-docs.sh 8c0b1f8697 Rework ASDs, add stub md+rst plugins, docs script, and stub tests. vor 13 Jahren

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 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.
  • Multi-site publishing support.

  • A Plugin API and plugins for...

    • Comments via Disqus
    • Analytics via Google
    • Deploying to Amazon S3.
    • Using LaTeX (inside pairs of $$) via Mathjax
    • Using ReStructured Text
    • Importing posts from wordpress
  • There is also a Heroku buildpack maintained by Jose Pereira.

  • Example sites: redlinernotes and (lisp :is 'fun).

Installation

This software should be portable to any conforming Common Lisp implementation but this guide will assume SBCL is installed. Testing has also been done on CCL. Server side setup:

  1. Setup git and create a bare repo as shown here.
  2. Install Lisp and Quicklisp.
  3. wget -c https://raw.github.com/redline6561/coleslaw/master/examples/single-site.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

Importing from Wordpress

There is a "plugin" to import from wordpress. At some point, it should be turned into a standalone script. Until then...

  1. Export your posts from wordpress.
  2. In your lisp of choice, do the following:
    1. (ql:quickload 'coleslaw)
    2. (in-package :coleslaw)
    3. (load-plugins '(import))
    4. (coleslaw-import::import-posts "/path/to/export.xml")

The XML will be read and placed into .post files in the :repo location specified in your .coleslawrc.

Writing your own plugins

For now, see the API and the existing plugins for an example. A proper guide about this will be written later.

Theming

A default theme, hyde, is provided. Themes are made using Google's closure-template and the source for hyde should be simple and instructive until I can provide better docs.