From e399b6063a2af280003dba30aa4c990fbd507b50 Mon Sep 17 00:00:00 2001 From: Brit Butler Date: Mon, 22 Apr 2013 09:59:26 -0400 Subject: [PATCH] Update docs. --- NEWS.md | 3 ++- docs/coleslaw.html | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index 2aad750..c865a70 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,6 @@ ## Changes for 0.9.2 (2013-05-xx): +* **INCOMPATIBLE CHANGE**: Renamed staging, deploy config options staging-dir, deploy-dir. * A plugin for Github Pages support. (thanks @mrordinaire!) * A new and improved implementation of tags. (thanks @woudshoo!) * A THEME-DOES-NOT-EXIST error is raised when the theme can't be found. @@ -13,7 +14,7 @@ ## Changes for 0.9 (2013-02-20): -* INCOMPATIBLE CHANGE: All :plugins in .coleslawrc must be lists. (i.e. (mathjax) not mathjax) +* **INCOMPATIBLE CHANGE**: All :plugins in .coleslawrc must be lists. (i.e. (mathjax) not mathjax) * Add support for analytics via Google. * Add support for Restructured Text via cl-docutils. * Add support for deploying to Amazon S3. diff --git a/docs/coleslaw.html b/docs/coleslaw.html index adaf8f0..acb7bcf 100644 --- a/docs/coleslaw.html +++ b/docs/coleslaw.html @@ -58,6 +58,17 @@ else 
Homepage: Github
+-Variables
+
+
+
+*config*: +NIL +variable
+
+
A variable to store the blog configuration and plugin settings.
+
+
-Classes
@@ -126,6 +137,14 @@ compile and deploy the blog.
The path to store OBJECT at once rendered.
+preview +path &optional (content-type 'post) +function
+
+
Render the content at PATH under user's configured repo and save it to
+~/tmp.html. Load the user's config and theme if necessary.
+
+
publish content-type standard-generic-function
@@ -133,6 +152,13 @@ compile and deploy the blog.
Write pages to disk for all content of the given CONTENT-TYPE.
+read-content +file +function
+
+
Returns a plist of metadata from FILE with :text holding the content as a string.
+
+
render object &key next prev &allow-other-keys standard-generic-function