Add example templates

_tpl/config.json

@@ -0,0 +1,6 @@
+{
+    "output": "output",
+    "contents": "contents",
+    "theme": "theme.js",
+    "title": "Pages"
+}

_tpl/contents/about.md

@@ -0,0 +1,15 @@
+---
+title: "About"
+static: true
+---
+# About sfftfth
+
+sfftfth is a static site generator written in JavaScript. It transforms Markdown files into static HTML files using
+a user-defined theme and a configuration file. It is shipped as a command line utility offering a simple interface
+and a good speed.
+
+Posts and pages are written in Markdown and can contain a Frontmatter configuration. It is used by sfftfth to process
+them (`static` and `draft` flags as well as `title` and `date`) and is also given to the theme allowing for custom
+properties and advanced post handling.
+
+It is an Open Source application hosted at [https://github.com/dak0rn/sfftfth](https://github.com/dak0rn/sfftfth).

_tpl/contents/howto.md

@@ -0,0 +1,160 @@
+---
+title: "Get started"
+static: true
+---
+
+# Get started with sfftfth
+
+`sfftfth` allows to create static HTML pages from Markdown files using a single command line utility, a trivial
+configuration and a simple theming mechanism.
+
+## Configuration
+
+The configuration file is used when rendering Markdown files into HTML. It is a JSON file and might
+look as follows:
+
+```json
+{
+    "output": "output",
+    "contents": "contents",
+    "theme": "theme.js",
+    "baseUrl": "/",
+    "title": "Pages",
+    "renderDrafts": false,
+    "outputMode": "directory"
+}
+```
+
+### Mandatory keys
+
+- `output` is the name of the output directory of the rendered files, either relative to the path of the configuration
+  file or an absolute path.
+- The `contents` key references the directory with files. This can be either relative or absolute again.
+- The theme to use is referenced with the `theme` key.
+
+### Optional keys
+
+- `baseUrl` is an optional key and provides the base URL of the pages allowing to serve them from a
+  subdirectory. It defaults to `/`.
+- `renderDrafts` indicates whether to render files that have a `draft: true` flag in their Frontmatter.
+   Defaults to `false`.
+- The `outputMode` flag determines the way files are created:
+  - `directory` (the default) indicates that directories are created for every file.<br />
+    `a/b/c/d.md` will then be rendered to `a/b/c/d/index.html`.
+  - `file` indicates that files are created for every file.<br />
+    `a/b/c/d.md` will then be rendered to `a/b/c/d.html`.
+
+### Other keys
+
+- Any other key (e.g. `title`) is not used by `sfftfth` but is provided to the theme functions.
+
+## Theming
+
+The theme referenced by the configuration is supposed to be a JavaScript file exporting an object with
+three functions:
+
+```JavaScript
+module.exports = {
+
+    index(files, config) {},
+
+    post(content, meta, config, file, files) {},
+
+    page(content, meta, config, file, files) {}
+}
+```
+
+- `index` creates the `index.html` file and is invoked with the list of files and the configuration.
+  See below for the accessible information of the file list.
+- `post` will be invoked for every file that is not static (not `static: true` in its Frontmatter). It
+  gets the rendered markdown, its frontmatter info, the configuration, the corresponding file record and
+  the list of all files.
+- `page` will be invoked for every file that is static (`static: true` in its Frontmatter). It
+  gets the rendered markdown, its frontmatter info, the configuration, the corresponding file record and
+  the list of all files.
+
+All functions are supposed to return complete HTML files as strings. That allows to use either *native* features
+like string interpolation or even add a full-featured templating engine like Handlebars or Jade.
+
+### File record
+
+Files (both in the list and as a separate argument) are represented using a file record. It consists of the
+following fields:
+
+```javascript
+{
+    // Relative path of the file
+    relativePath: void 0,
+
+    // Absolute path of the file
+    absolutePath: void 0,
+
+    // Output file (dir + file name)
+    outputPath: void 0,
+
+    // Directory for the output
+    outputDirectory: void 0,
+
+    // Frontmatter metadata
+    meta: {
+        // A date, set automatically to today in `YYYY-MM-DD` if not given
+        date: void 0
+    },
+
+    // The parsed markdown
+    contents: void 0,
+
+    // Relative URI to the post/page
+    uri: void 0
+}
+```
+
+## File structure
+
+`sfftfth` collects all Markdown files in the given `contents` directory recursively.
+The file and folder structure represents a file's URI when rendered. Depending on the configuration, files are
+either stored in separate directories as `index.html` or as rendered HTML file with the original name.
+
+- `outputMode = 'directory'`
+  - `about.md` &rarr; `about/index.html`
+  - `pages/blog.md` &rarr; `pages/blog/index.html`
+  - `projects/1998/parade.md` &rarr; `projects/1998/parade/index.html`
+- `outputMode = 'file'`
+  - `about.md` &rarr; `about.html`
+  - `pages/blog.md` &rarr; `pages/blog.html`
+  - `projects/1998/parade.md` &rarr; `projects/1998/parade.html`
+
+## Rendering
+
+Rendering is started with the `sfftfth` cli. If the configuration file is named `config.json` it can
+be invoked without any arguments from the same directory. If the config has a different name it has to be
+named explicitly.
+
+```bash
+sfftfth
+# Same as:
+sfftfth -c config.js
+```
+
+## Bootstrapping
+
+To provide a starting point, `sfftfth` can generate a sample configuration, sample theme and a few markdown files.
+The CLI uses the `-b` flag for that:
+
+```bash
+sfftfth -b example-directory
+```
+
+## CLI help
+
+
+    usage: sfftfth [-h] [-v] [-c config file] [-b directory name]
+
+
+    A very simple static site generator
+
+    Optional arguments:
+      -h, --help         Show this help message and exit.
+      -v, --version      Show program's version number and exit.
+      -c config file     Path to the sfftfth config file, default: config.json
+      -b directory name  Bootstrap a new setup in the given existing directory

_tpl/contents/start.md

@@ -0,0 +1,8 @@
+---
+title: 'First Entry'
+---
+
+# Hello world
+
+This is the first post created with `sfftfth`. It is a non-static entry and therefore not accessible via
+the top level navigation but using the post list rendered on the index page.