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

Update docs.

Browse source
This commit is contained in:
Brit Butler 2013-04-22 09:59:26 -04:00
parent e12f5edc79
commit e399b6063a
2 changed files with 28 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
NEWS.md
View file

@ -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.

26
docs/coleslaw.html
View file

@ -58,6 +58,17 @@ else
<pre>Homepage: <a href="http://github.com/redline6561/coleslaw">Github</a></pre></div>
<div class="frame">
<div class="labeltitle">
<span class="expander" onclick="expand(this, 'vars');">-</span>Variables</div>
<div id="vars">
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="*config*_vars" href="#*config*_vars">*config*</a>:
<span class="value">NIL</span>
<span class="symboltype">variable</span></div>
<div class="documentation">
<pre>A variable to store the blog configuration and plugin settings.</pre></div></div></div></div>
<div class="frame">
<div class="labeltitle">
<span class="expander" onclick="expand(this, 'classes');">-</span>Classes</div>
<div id="classes">
<div class="symboldecl">
@ -126,6 +137,14 @@ compile and deploy the blog.</pre></div></div>
<pre>The path to store OBJECT at once rendered.</pre></div></div>
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="preview_func" href="#preview_func">preview</a>
<span class="lambdalist">path &optional (content-type 'post)</span>
<span class="symboltype">function</span></div>
<div class="documentation">
<pre>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.</pre></div></div>
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="publish_func" href="#publish_func">publish</a>
<span class="lambdalist">content-type</span>
<span class="symboltype">standard-generic-function</span></div>
@ -133,6 +152,13 @@ compile and deploy the blog.</pre></div></div>
<pre>Write pages to disk for all content of the given CONTENT-TYPE.</pre></div></div>
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="read-content_func" href="#read-content_func">read-content</a>
<span class="lambdalist">file</span>
<span class="symboltype">function</span></div>
<div class="documentation">
<pre>Returns a plist of metadata from FILE with :text holding the content as a string.</pre></div></div>
<div class="symboldecl">
<div class="definition">
<a class="symbolname" name="render_func" href="#render_func">render</a>
<span class="lambdalist">object &key next prev &allow-other-keys</span>
<span class="symboltype">standard-generic-function</span></div>