marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Markdown fixes, TODO update.

Browse source
This commit is contained in:
Brit Butler 2012-08-26 14:48:23 -04:00
parent 74e6b7d994
commit 5d7b422a86
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -1,4 +1,6 @@
Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll. # coleslaw
Coleslaw aims to be flexible blog software suitable for replacing a single-user static site compiler such as Jekyll. Coleslaw was a nickname of my favorite poet [Czeslaw Milosz](http://blog.redlinernotes.com/tag/milosz.html).
# Features # Features
* Git for storage * Git for storage
@ -12,6 +14,7 @@ Coleslaw aims to be flexible blog software suitable for replacing a single-user
# Installation # 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. 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: Server side setup:
1. Setup git and create a bare repo as shown [here](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server). 1. Setup git and create a bare repo as shown [here](http://git-scm.com/book/en/Git-on-the-Server-Setting-Up-the-Server).
2. Install Lisp and Quicklisp. 2. Install Lisp and Quicklisp.
3. For now, git clone https://github.com/redline6561/coleslaw.git inside ~/quicklisp/local-projects/. This is only temporarily necessary until coleslaw is in quicklisp. 3. For now, git clone https://github.com/redline6561/coleslaw.git inside ~/quicklisp/local-projects/. This is only temporarily necessary until coleslaw is in quicklisp.
@ -20,6 +23,7 @@ Server side setup:
6. ```chmod +x your-blog/.git/hooks/post-receive``` 6. ```chmod +x your-blog/.git/hooks/post-receive```
7. 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. 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```
8. The only thing left to do is point a web server of your choice at the symlink /path/to/deploy-dir/.curr/ 8. The only thing left to do is point a 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. 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 # The Post Format
@ -36,12 +40,14 @@ your post
# Importing from Wordpress # Importing from Wordpress
There is a "plugin" to import from wordpress. At some point, it should be turned into a standalone script. Until then... 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. 1. Export your posts from wordpress.
2. In your lisp of choice, do the following: 2. In your lisp of choice, do the following:
1. ```(ql:quickload 'coleslaw)``` 1. ```(ql:quickload 'coleslaw)```
2. ```(in-package :coleslaw)``` 2. ```(in-package :coleslaw)```
3. ```(load-plugins '(import))``` 3. ```(load-plugins '(import))```
4. ```(coleslaw-import::import-posts "/path/to/export.xml")``` 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](http://github.com/redline6561/coleslaw/blob/master/example.coleslawrc). The XML will be read and placed into .post files in the :repo location specified in your [.coleslawrc](http://github.com/redline6561/coleslaw/blob/master/example.coleslawrc).
# Writing your own plugins # Writing your own plugins

1
TODO
View file

@ -13,7 +13,6 @@ Plugins? Injection support for HEAD and BODY. What about predicate-based injecti
How is it served? Hunchentoot, Lighttpd, S3, whomever! How is it served? Hunchentoot, Lighttpd, S3, whomever!
TODO: TODO:
; test mathjax+markdown
; doc themes and plugins ; doc themes and plugins
; fix plugins: s3 ; fix plugins: s3
;; Incremental compile: only "touched" posts+tags+months. By-20 must be redone, of course. ;; Incremental compile: only "touched" posts+tags+months. By-20 must be redone, of course.