specter/kiln
1
0
Fork 0
mirror of https://git.sr.ht/~adnano/kiln synced 2024-12-29 06:43:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
adnano 2020-09-29 14:20:57 -04:00
parent 9de0d79bff
commit bf6050c926
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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
<!DOCTYPE html>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="stylesheet" href="/style.css">
<title><!-- Page title --></title>
<!-- Page content -->
```
## 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.