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

Brit Butler 47e2ca02c1 README updates. 12 年之前
docs e89060dc8e Bump version to 0.6.5, update docs. 12 年之前
plugins ed98a5bd69 Fix destructuring and other minor thinkos. 12 年之前
src 4b8145a7ca Remove DATE-TO-TIMESTAMP since it was unused. 12 年之前
tests 8c0b1f8697 Rework ASDs, add stub md+rst plugins, docs script, and stub tests. 13 年之前
themes 2a248f96e9 Rename rss->rss-feed for template name consistency. 12 年之前
.gitignore a698389c42 Implement DEPLOY, package updates, minor tweaks. 13 年之前
README.md 47e2ca02c1 README updates. 12 年之前
TODO 2240dea8ba Add TODO note. 12 年之前
coleslaw.asd f52ef504fd Got it working with CCL. 12 年之前
example-ccl.post-receive f52ef504fd Got it working with CCL. 12 年之前
example.coleslawrc f7a48d4a6e Minor fixes to RENDER-FEEDS, example config, base template. 12 年之前
example.post-receive 27e8ed0590 Minor bugfixes and RENDER-POSTS cleanup. 12 年之前
gen-docs.sh 8c0b1f8697 Rework ASDs, add stub md+rst plugins, docs script, and stub tests. 13 年之前

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.
  • Plugins for...
    • Comments via Disqus
    • Using LaTeX (inside pairs of $$) via Mathjax
    • 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/example.coleslawrc -O ~/.coleslawrc # and edit as necessary
  4. wget -c https://raw.github.com/redline6561/coleslaw/master/example.post-receieve -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 mathjax plugin 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.