README.markdown in stack-0.0.6 vs README.markdown in stack-0.0.7
- old
+ new
@@ -1,6 +1,6 @@
-Stack
+stack
=====
Generates a static site from template files with YAML and Liquid. Stack supports template transformation through Markdown, Textile and Less CSS.
Within template files, stack allows you to use bi-directional YAML variables and include files.
@@ -33,41 +33,52 @@
generate
Generate runs through the source and transforms the templates, if no source is specified the current directory will be used.
+ gen
+
+Alias of `generate`.
+
server
-Runs a web server serving the output of the transformed source, by default when running Stack in server mode your templates will be automatically transformed when changed (this can be disabled).
+Runs a web server serving the output of the transformed source, by default when running stack in server mode your templates will be automatically transformed when changed (this can be disabled).
watch
Watches a directory and re-builds whenever theres file changes.
#### Options
- --source
+ --source [DIR]
- --target
+Directory to use as the source for generating a site with stack, by default the current directory will be used.
+ --target [DIR]
+
+Directory to use as the target directory, if none is specified the target will be a folder called `_stack` in the source directory.
+
##### Server Options
- --port
+ --port [PORT]
- --watches
+Specifies the port number the server should use when serving content through the `server` command.
-
+ --disable-watch
+
+Disables automatic transformation when serving content through the `server` command.
+
### Ruby
require 'stack'
Stack::Generator.new("/path/to/source", "/path/to/target")
Templates and YAML
------------------
-Template files can contain YAML block's that are processed by Stack and can be used to define Liquid variables for use in your templates. A YAML block can be something like;
+Template files can contain YAML block's that are processed by stack and can be used to define Liquid variables for use in your templates. A YAML block can be something like;
---
layout: application
title: Page Title
---
@@ -78,14 +89,14 @@
This specifies the layout file to use around the content, theres no need to specify the extension. The layout must be defined in a file inside a `_layout` folder that is within the current template scope, if you have templates defined in a sub-folder you can have a `_layout` folder that only templates in the sub-folder can access.
generator
-This variable holds the current hash used to transform the current template. You should not override this from the YAML block.
+This variable holds the current hash used to transform the current template. You should not override this from the YAML block.
generator.time
-The current Time from when the Stack processed and transformed the templates.
+The current Time from when the stack processed and transformed the templates.
generator.processed_at
The current Time the `generator` processed the templates.
\ No newline at end of file