Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

add example config file, readme edits

  • Loading branch information...
commit 5905ec08752d9e6ebea9d0d0abcb052c7f8ab50b 1 parent 7dcff44
@nuex authored
Showing with 51 additions and 5 deletions.
  1. +4 −5 README.md
  2. +47 −0 example/site/.zod/config
View
9 README.md
@@ -1,4 +1,4 @@
-# zodiac - a static site generator
+# zodiac
ZODIAC is a static website generator powered by sh and awk. The core features of zodiac are:
@@ -8,7 +8,7 @@ ZODIAC is a static website generator powered by sh and awk. The core features of
* a simple, easy to use templating system
* supports custom helpers written in awk
* configuration, meta, helpers, etc. can be added as you need them
-* convert your markup using any external command that accepts a unix pipe (smu, asciidoc, discount, rst2html, etc)
+* convert your markup using any external command that accepts a UNIX-style pipe (smu, asciidoc, discount, rst2html, etc)
## SYNOPSIS
@@ -72,7 +72,7 @@ Page metadata will always override global metadata of the same key.
Templates come in two forms, page templates and layout templates. Metadata can be bound to templates by using the `{{key}}` notation in your pages and layout files.
-Page templates can have any extension that zodiac can convert. Out of the box, page templates can have `md`, `htm`, or an `html` extension. Other extensions can be supported if they are configured in the `.zod/config` file in the project directory.
+Page templates can have any extension that zodiac can convert. Out of the box, page templates can have an `md`, `htm`, or `html` extension. Other extensions and markup types can be supported if they are configured in the `.zod/config` file in the project directory.
The `main.layout` file wraps HTML content around a page template. A `main.layout` file could look something like this:
@@ -125,8 +125,7 @@ Just be sure to set the data array in the `load_helpers()` function at the top o
For more control over the parsing and conversion process, a `.zod/config` file can be created within your project directory. Here is a sample config:
[parse]
- htm
- html
+ htm,html
[parse_convert]
md smu
View
47 example/site/.zod/config
@@ -0,0 +1,47 @@
+; This is an example zodiac configuration file
+; A line starting with a `;` is a comment and is ignored.
+
+; The `parse` section is for page templates that will not be converted to
+; HTML via an external utility.
+;
+; [parse]
+; extension,extension
+; extension
+; ...
+;
+
+
+; [parse]
+; htm
+; html
+
+
+; The `parse_convert` section is for page templates that will be converted
+; to HTML via an external utility.
+;
+; By default, page templates with the `md` extension are piped through the
+; built-in awk implementation of Markdown.
+;
+; [parse_convert]
+; extension,extension command
+; extension command
+; ...
+
+
+; [parse_convert]
+; md,markdown discount
+; txt asciidoc -s -
+
+
+; The `ignore` section is for patterns that zodiac will ignore when
+; searching the project directory. Ignored files will not be parsed or
+; copied to the target directory.
+;
+; [ignore]
+; pattern
+; pattern
+; ...
+
+
+; [ignore]
+; Makefile
Please sign in to comment.
Something went wrong with that request. Please try again.