diff --git a/README.md b/README.md index fff235a..944b4db 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ A simple static site generator for Gemini. - Simple and fast - Gemini support - Go templates +- Export to HTML ## Installation @@ -31,11 +32,25 @@ templates/ Templates page.gmi Page template index.gmi Directory index template dst/ Site destination +dst.html/ Site HTML destination ``` Running `kiln` takes the contents in `src`, runs them through the templates in `templates`, and writes the result to `dst`. +If the `-html` flag is provided, `kiln` will also export the Gemini content as +HTML and output it to `dst.html`. The generated HTML will look like this: + +```html + + + + +<!-- Page title --> + + +``` + ## Permalinks Every page and directory in the site is assigned a permalink. @@ -51,6 +66,8 @@ directory: src/posts/ permalink: /posts/ ``` +Pages and directory index files are written to `{{ .Permalink }}/index.html`. + ## Templates Templates are located in the `templates` directory.