Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update feature list, command line parameters and add some minor information.
  • Loading branch information
Norbert Eder committed Oct 16, 2013
1 parent 92c8ebc commit 3f05fc2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ gullap is a Microsoft .NET/[Mono](http://www.mono-project.com "Mono") based stat
* Supports [YAML](http://yaml.org/ "YAML") Front Matter
* Include HTML to your markup files
* Site structure generation
* Generate single files/posts
* Support of pages and posts
* Support of static HTML files

### Extensibility

Expand All @@ -24,22 +27,28 @@ There are the following options to call gullap:
GullapConsole -i my/Path/To/My/Site
GullapConsole -g my/Path/To/My/Site
GullapConsole -g
GullapConsole -f my/Path/To/A/File

The argument `-i` generates the necessary structure within `my/Path/To/My/Site`. Therefore the target path has to exist. It is not created by gullap. The file structure looks like the following

Site
|- assets
|- output
|- pages
|- posts
|- templates

Copy all your necessary assets (CSS, JavaScript, Images) into `assets`. They will be copied to the `output` directory as they are. So, if you have sub directories they will be available also within the output directory. The `pages` directory contains your markup. Per default they should contain all your Markdown files (the extension of your files is unimportant, as all files are taken for the transformation). Put all your Nustache templates to the `templates` directory.

After you filled up the structure with all necessary files, call `GullapConsole` with argument `-g` and the path to your site directory. Everything will be generated to the `output` directory. In case you use `-g` without giving a site path, the current directory will be used as the site path.

Using the parameter `-f` you can define a single file to be builded. The parameter needs a file path. This can either be an absolute path, a relative one or just the filename. In that case the first file matching the given name will be built, so take care if there are more having this name.

Use `GullapConsole -h` you can show help information. Add `-v` to your commands to get the full output.

## YAML Front Matter

Since version 1.1 Gullap uses a *YAML Front Matter* (as for example [Jekyll](http://jekyllrb.com/ "Jekyll") does. Each file that has a valid front matter will be processed. The following front matter attributes are currently available:
Since version 1.1 Gullap uses a *YAML Front Matter* (as for example [Jekyll](http://jekyllrb.com/ "Jekyll") does. Each file that has a valid front matter will be processed. The following front matter attributes are currently available for pages:

title Title of the page
description Description of the page
Expand All @@ -50,6 +59,8 @@ Since version 1.1 Gullap uses a *YAML Front Matter* (as for example [Jekyll](htt
tags Keywords for your page
draft Defines whether this page is in draft mode or not

The same attributes are available for posts, except `description`.

There is one template that MUST exist: `page.template`. This is the default template. Use `template` to override that.

Here is an example of a valid front matter:
Expand Down

0 comments on commit 3f05fc2

Please sign in to comment.