specter/kiln
1
0
Fork 0
mirror of https://git.sr.ht/~adnano/kiln synced 2024-10-30 01:13:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
adnano 2020-09-30 00:02:49 -04:00
parent 399e543b4a
commit 8c40cf81f5
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -4,7 +4,6 @@ A simple static site generator for Gemini.
## Features
- Zero configuration
- Simple and fast
- Gemini support
- Go templates
@ -23,6 +22,10 @@ go install
kiln
```
To export to HTML, use the `-html` flag.
To generate Atom feeds, use the `-atom` flag.
## Directory Structure
A kiln site is organized in the following way:
@ -67,7 +70,7 @@ directory: src/posts/
permalink: /posts/
```
Pages and directory index files are written to `{{ .Permalink }}/index.html`.
Pages and directory index files are written to `{{ .Permalink }}/index.gmi`.
## Templates
@ -78,8 +81,6 @@ These are the supported templates:
- `index.gmi`: The template used for directory index files
- `atom.xml`: The template used when generating Atom feeds
To generate Atom feeds, run `kiln` with the `-atom` flag.
### Page templates
Page templates are provided with the following information: