浏览代码

Update docs.

Brit Butler 12 年之前
父节点
当前提交
e399b6063a
共有 2 个文件被更改,包括 28 次插入1 次删除
  1. 2 1
      NEWS.md
  2. 26 0
      docs/coleslaw.html

+ 2 - 1
NEWS.md

@@ -1,5 +1,6 @@
1 1
 ## Changes for 0.9.2 (2013-05-xx):
2 2
 
3
+* **INCOMPATIBLE CHANGE**: Renamed staging, deploy config options staging-dir, deploy-dir.
3 4
 * A plugin for Github Pages support. (thanks @mrordinaire!)
4 5
 * A new and improved implementation of tags. (thanks @woudshoo!)
5 6
 * A THEME-DOES-NOT-EXIST error is raised when the theme can't be found.
@@ -13,7 +14,7 @@
13 14
 
14 15
 ## Changes for 0.9 (2013-02-20):
15 16
 
16
-* INCOMPATIBLE CHANGE: All :plugins in .coleslawrc must be lists. (i.e. (mathjax) not mathjax)
17
+* **INCOMPATIBLE CHANGE**: All :plugins in .coleslawrc must be lists. (i.e. (mathjax) not mathjax)
17 18
 * Add support for analytics via Google.
18 19
 * Add support for Restructured Text via cl-docutils.
19 20
 * Add support for deploying to Amazon S3.

+ 26 - 0
docs/coleslaw.html

@@ -58,6 +58,17 @@ else
58 58
 <pre>Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a></pre></div>
59 59
 <div class="frame">
60 60
 <div class="labeltitle">
61
+<span class="expander" onclick="expand(this, 'vars');">-</span>Variables</div>
62
+<div id="vars">
63
+<div class="symboldecl">
64
+<div class="definition">
65
+<a class="symbolname" name="*config*_vars" href="#*config*_vars">*config*</a>: 
66
+<span class="value">NIL</span>
67
+<span class="symboltype">variable</span></div>
68
+<div class="documentation">
69
+<pre>A variable to store the blog configuration and plugin settings.</pre></div></div></div></div>
70
+<div class="frame">
71
+<div class="labeltitle">
61 72
 <span class="expander" onclick="expand(this, 'classes');">-</span>Classes</div>
62 73
 <div id="classes">
63 74
 <div class="symboldecl">
@@ -126,6 +137,14 @@ compile and deploy the blog.</pre></div></div>
126 137
 <pre>The path to store OBJECT at once rendered.</pre></div></div>
127 138
 <div class="symboldecl">
128 139
 <div class="definition">
140
+<a class="symbolname" name="preview_func" href="#preview_func">preview</a>
141
+<span class="lambdalist">path &optional (content-type 'post)</span>
142
+<span class="symboltype">function</span></div>
143
+<div class="documentation">
144
+<pre>Render the content at PATH under user's configured repo and save it to
145
+~/tmp.html. Load the user's config and theme if necessary.</pre></div></div>
146
+<div class="symboldecl">
147
+<div class="definition">
129 148
 <a class="symbolname" name="publish_func" href="#publish_func">publish</a>
130 149
 <span class="lambdalist">content-type</span>
131 150
 <span class="symboltype">standard-generic-function</span></div>
@@ -133,6 +152,13 @@ compile and deploy the blog.</pre></div></div>
133 152
 <pre>Write pages to disk for all content of the given CONTENT-TYPE.</pre></div></div>
134 153
 <div class="symboldecl">
135 154
 <div class="definition">
155
+<a class="symbolname" name="read-content_func" href="#read-content_func">read-content</a>
156
+<span class="lambdalist">file</span>
157
+<span class="symboltype">function</span></div>
158
+<div class="documentation">
159
+<pre>Returns a plist of metadata from FILE with :text holding the content as a string.</pre></div></div>
160
+<div class="symboldecl">
161
+<div class="definition">
136 162
 <a class="symbolname" name="render_func" href="#render_func">render</a>
137 163
 <span class="lambdalist">object &key next prev &allow-other-keys</span>
138 164
 <span class="symboltype">standard-generic-function</span></div>