coleslaw/README

37 lines
1.6 KiB
Text
Raw Normal View History

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.
2011-04-16 15:45:37 -04:00
2012-08-22 00:11:33 -04:00
Full docs coming soon...
2012-08-19 00:29:44 -04:00
Features:
* Git for storage
2012-08-22 00:11:33 -04:00
* RSS feeds!
2012-08-19 00:29:44 -04:00
* Plugins to...
** Import from wordpress
** Use Mathjax/LaTeX
Forthcoming:
* Markdown support
* RST support
2012-08-22 00:11:33 -04:00
* Host on Amazon S3
2012-08-19 00:29:44 -04:00
* Code highlighting
2011-04-16 15:45:37 -04:00
References:
-- Jekyll
-- Hakyll
-- Hyde
2012-08-19 00:29:44 -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:
2012-08-22 14:05:51 -04:00
* Setup git and create a bare repo as shown [here](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server).
* 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.
2012-08-22 10:32:30 -04:00
* cp coleslaw/example.coleslawrc ~/.coleslawrc # and edit as necessary for your repo location, deploy location, etc
2012-08-25 15:20:19 -04:00
* cp coleslaw/example.post-receieve your-blog.git/hooks/post-receive
* chmod +x your-blog/.git/hooks/post-receive
2012-08-25 15:20:19 -04:00
* 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
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