Little more doc work, fix versioned plugin thinko.

This commit is contained in:
Brit Butler 2014-09-12 16:21:50 -04:00
parent 60302d5f47
commit b2082175e3
3 changed files with 18 additions and 8 deletions

View file

@ -217,8 +217,6 @@ PAGE, a content type for static page support, is available as a plugin.
### TODO for 0.9.6 ### TODO for 0.9.6
* Finish docs updates to:
* plugin-use.md -> Incremental plugin, Versioned plugin. Twitter summary cards.
* A real test suite with Stefil that at *least* tests: * A real test suite with Stefil that at *least* tests:
* `read-content` * `read-content`
* `load-config` * `load-config`

View file

@ -1,8 +1,8 @@
# General Use # General Use
* Add a list with the plugin name and settings to the ```:plugins``` * To enable a plugin, add its name and settings to your
section of your [.coleslawrc][config_file]. Plugin settings are [.coleslawrc][config_file]. Plugin settings are described
described below. below. Note that some plugins require additional setup.
* Available plugins are listed below with usage descriptions and * Available plugins are listed below with usage descriptions and
config examples. config examples.
@ -41,9 +41,9 @@
**Example**: `(incremental)` **Example**: `(incremental)`
**Setup**: **Setup**: You must run the `examples/dump_db.sh` script to
- You must run the `examples/dump_db.sh` script to generate a database dump generate a database dump for your site before enabling the
for your site before enabling the incremental plugin. incremental plugin.
## LaTeX via Mathjax ## LaTeX via Mathjax
@ -144,6 +144,16 @@ CL-USER> (chirp:complete-authentication "4173325")
#<CHIRP-OBJECTS:USER PuercoPop #18405433> #<CHIRP-OBJECTS:USER PuercoPop #18405433>
``` ```
## Versioned Deploys
**Description**: Originally, this was Coleslaw's only deploy behavior.
Instead of deploying directly to `:deploy-dir`, creates `.curr` and
`.prev` symlinks in the *deploy-dir*, which point to timestamped
directories of the last two deploys of the site. Deploys prior to the
last two are automatically cleaned up.
**Example**: `(versioned)`
## Wordpress Importer ## Wordpress Importer
**NOTE**: This plugin really should be rewritten to act as a **NOTE**: This plugin really should be rewritten to act as a

View file

@ -20,3 +20,5 @@
(when (probe-file curr) (when (probe-file curr)
(update-symlink prev (truename curr))) (update-symlink prev (truename curr)))
(update-symlink curr new-build))) (update-symlink curr new-build)))
(defun enable ())