Skip to content

Commit

Permalink
Documentation updates (thanks to deepakjois).
Browse files Browse the repository at this point in the history
  • Loading branch information
John MacFarlane committed Jan 2, 2010
1 parent 802deb4 commit 2175d5b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.markdown
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -169,11 +169,12 @@ The configuration file specifies the following:


- `indexfile`: the filename of the index file (default: `index.yaml`) - `indexfile`: the filename of the index file (default: `index.yaml`)
- `title`: the title of the whole site - `title`: the title of the whole site
- `templatedir`: the directory containing templates (default: `.`) - `sourcedir`: the directory containing all the templates and page sources
(default: `.`)
- `datadir`: the directory containing yaml data files (default: `.`) - `datadir`: the directory containing yaml data files (default: `.`)
- `filesdir`: the directory containing static files (default: `files`) - `filesdir`: the directory containing static files (default: `files`)
- `layout`: the default layout template for the site (default: - `layout`: the default layout template for the site, relative to
`layout.html.st`) `sourcedir` (default: `layout.html.st`)


### `index.yaml` and submenus ### `index.yaml` and submenus


Expand All @@ -193,7 +194,8 @@ fields:
menu menu


Each page must have at least `url`, `title`, and either `template` or Each page must have at least `url`, `title`, and either `template` or
`source`. `source`. Values for `template`, `source`, and `layout` are relative to
`sourcedir` specified in `config.yaml`.


The pages may be organized into a tree-like hierarchy, which will be The pages may be organized into a tree-like hierarchy, which will be
reflected in the site navigation menu. It is easiest to see how this reflected in the site navigation menu. It is easiest to see how this
Expand Down

0 comments on commit 2175d5b

Please sign in to comment.