marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Flexible Lisp Blogware
326 commits 10 branches 0 tags 1.6 MiB
Common Lisp 90.3%
CSS 7.5%
Shell 2.2%
Find a file
Brit Butler 3ee8f43325 Remove dead code in PAGE-URL. 
We partially support 'pretty URLs'. They can be achieved by setting
:page-ext in the *config* to "/" and configuring the web server to
ignore html extensions.
2014-04-08 16:59:56 -04:00
docs Make feeds a subclass of indexes. Cleanup! 2014-04-08 16:51:53 -04:00
examples Use sitemap plugin in the default config. 2013-05-01 15:42:05 -04:00
plugins make output from restructured text generator useable 2014-03-01 22:27:17 -05:00
src Remove dead code in PAGE-URL. 2014-04-08 16:59:56 -04:00
tests Add a sanity test to prevent future embarrassment. 2013-04-21 16:05:32 -04:00
themes Remove dead code in PAGE-URL. 2014-04-08 16:59:56 -04:00
.gitignore Implement DEPLOY, package updates, minor tweaks. 2012-08-19 00:29:33 -04:00
coleslaw.asd Rename indices file. 2014-04-07 20:56:33 -04:00
gen-docs.sh Rework ASDs, add stub md+rst plugins, docs script, and stub tests. 2012-08-14 23:58:28 -04:00
LICENSE Add BSD License file. 2013-01-29 10:18:26 -05:00
NEWS.md Release: 0.9.2! 2013-05-11 20:37:58 -04:00
README.md Minor README tweak. 2014-03-23 13:11:42 -04:00
TODO Minor TODO update. 2013-06-08 17:22:41 -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 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
    • Hosting via Github Pages
    • Deploying to Amazon S3
    • Using LaTeX (inside pairs of ) via Mathjax
    • Using ReStructured Text
    • Sitemap generation
    • Importing posts from wordpress

  • There is also a Heroku buildpack maintained by Jose Pereira.

  • Example sites: redlinernotes, kenan-bolukbasi.log, and Nothing Really Matters.

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

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.