coleslaw/README

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

Full docs coming soon...

Features:
* Git for storage
* RSS feeds!
* Plugins to...
** Import from wordpress
** Use Mathjax/LaTeX

Forthcoming:
* Markdown support
* RST support
* Host on Amazon S3
* Code highlighting

References:
-- Jekyll
-- Hakyll
-- Hyde

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:
* Clone or create the git repo for your blog.
* Install Lisp and Quicklisp.
* For now, git clone https://github.com/redline6561/coleslaw.git and add
           (push "/path/to/coleslaw/" asdf:*central-registry*) to your lisp's init file. (e.g. ~/.sbclrc for SBCL)
             -- You may need to (require 'asdf) in that file first or even create it! (Don't panic.)
      This is only temporarily necessary until coleslaw is in quicklisp.
* cp coleslaw/example.coleslawrc ~/.coleslawrc # and edit as necessary for your repo location, deploy location, etc
* Edit your-blog/.git/hooks/post-receieve and insert:
sbcl --eval "(progn (ql:quickload :coleslaw) (coleslaw:main) (sb-ext:quit))" # or (sb-ext:exit) on SBCL >= 1.0.57
* chmod +x your-blog/.git/hooks/post-receive
Now whenever you push a new commit to the server, coleslaw will update your blog automatically!
The only thing left to do is point a web server of your choice at the symlink /path/to/coleslaw/.curr
README tweak. 2012-08-19 00:29:44 -04:00			`Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll.`
Restructuring and API rewrite. 2011-04-16 15:45:37 -04:00
Add docs and further RSS tweaks. 2012-08-22 00:11:33 -04:00			`Full docs coming soon...`

README tweak. 2012-08-19 00:29:44 -04:00			`Features:`
			`* Git for storage`
Add docs and further RSS tweaks. 2012-08-22 00:11:33 -04:00			`* RSS feeds!`
README tweak. 2012-08-19 00:29:44 -04:00			`* Plugins to...`
			`** Import from wordpress`
			`** Use Mathjax/LaTeX`

			`Forthcoming:`
			`* Markdown support`
			`* RST support`
Add docs and further RSS tweaks. 2012-08-22 00:11:33 -04:00			`* Host on Amazon S3`
README tweak. 2012-08-19 00:29:44 -04:00			`* Code highlighting`
Restructuring and API rewrite. 2011-04-16 15:45:37 -04:00
			`References:`
			`-- Jekyll`
			`-- Hakyll`
			`-- Hyde`
README tweak. 2012-08-19 00:29:44 -04:00
A serverside commithook should kick off the compile. 2012-08-22 10:05:02 -04:00			`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:`
			`* Clone or create the git repo for your blog.`
			`* Install Lisp and Quicklisp.`
			`* For now, git clone https://github.com/redline6561/coleslaw.git and add`
			`(push "/path/to/coleslaw/" asdf:central-registry) to your lisp's init file. (e.g. ~/.sbclrc for SBCL)`
			`-- You may need to (require 'asdf) in that file first or even create it! (Don't panic.)`
			`This is only temporarily necessary until coleslaw is in quicklisp.`
Make deploy location configurable. 2012-08-22 10:32:30 -04:00			`* cp coleslaw/example.coleslawrc ~/.coleslawrc # and edit as necessary for your repo location, deploy location, etc`
A serverside commithook should kick off the compile. 2012-08-22 10:05:02 -04:00			`* Edit your-blog/.git/hooks/post-receieve and insert:`
			`sbcl --eval "(progn (ql:quickload :coleslaw) (coleslaw:main) (sb-ext:quit))" # or (sb-ext:exit) on SBCL >= 1.0.57`
			`* chmod +x your-blog/.git/hooks/post-receive`
			`Now whenever you push a new commit to the server, coleslaw will update your blog automatically!`
			`The only thing left to do is point a web server of your choice at the symlink /path/to/coleslaw/.curr`