mirror of
https://git.sr.ht/~adnano/kiln
synced 2024-10-30 09:23:09 +00:00
Fix build error
This commit is contained in:
parent
66b93d7299
commit
246bfd0033
114
doc/kiln.1.scd
Normal file
114
doc/kiln.1.scd
Normal file
|
@ -0,0 +1,114 @@
|
||||||
|
kiln(1)
|
||||||
|
|
||||||
|
# NAME
|
||||||
|
|
||||||
|
kiln - a simple static site generator for Gemini sites
|
||||||
|
|
||||||
|
# SYNOPSIS
|
||||||
|
|
||||||
|
_kiln_
|
||||||
|
|
||||||
|
# SITE STRUCTURE
|
||||||
|
|
||||||
|
A kiln site is organized in the following way:
|
||||||
|
|
||||||
|
|[ *Directory*
|
||||||
|
:[ *Description*
|
||||||
|
| src/
|
||||||
|
: Site source
|
||||||
|
| templates/
|
||||||
|
: Templates
|
||||||
|
| dst/
|
||||||
|
: Site destination
|
||||||
|
| dst.html/
|
||||||
|
: Site HTML destination
|
||||||
|
|
||||||
|
# TEMPLATES
|
||||||
|
|
||||||
|
kiln looks for templates in the "templates" directory.
|
||||||
|
The following templates are accepted:
|
||||||
|
|
||||||
|
|[ *Template*
|
||||||
|
:[ *Description*
|
||||||
|
| page.gmi
|
||||||
|
: Page template
|
||||||
|
| index.gmi
|
||||||
|
: Directory index template
|
||||||
|
| output.html
|
||||||
|
: text/gemini to HTML template
|
||||||
|
|
||||||
|
## PAGE TEMPLATES
|
||||||
|
|
||||||
|
Page templates are provided with the following information:
|
||||||
|
|
||||||
|
|[ *Variable*
|
||||||
|
:[ *Description*
|
||||||
|
| Title
|
||||||
|
: The title of the page
|
||||||
|
| Date
|
||||||
|
: The date of the page
|
||||||
|
| Permalink
|
||||||
|
: Permalink to the page
|
||||||
|
| Content
|
||||||
|
: The contents of the page
|
||||||
|
|
||||||
|
Pages can specify dates in their filenames.
|
||||||
|
kiln will recognize the date and remove it from the permalink.
|
||||||
|
|
||||||
|
Pages can also specify titles in their content.
|
||||||
|
kiln will parse and remove the title from the content.
|
||||||
|
|
||||||
|
## INDEX TEMPLATES
|
||||||
|
|
||||||
|
Index templates are provided with the following information:
|
||||||
|
|
||||||
|
|[ *Variable*
|
||||||
|
:[ *Description*
|
||||||
|
| Permalink
|
||||||
|
: Permalink to the directory
|
||||||
|
| Pages
|
||||||
|
: List of pages in this directory
|
||||||
|
| Directories
|
||||||
|
: List of subdirectories
|
||||||
|
|
||||||
|
# PERMALINKS
|
||||||
|
|
||||||
|
Every page and directory in the site is assigned a permalink.
|
||||||
|
Permalinks are absolute and point to the destination file.
|
||||||
|
All files are written to their permalink plus "index.gmi".
|
||||||
|
|
||||||
|
# FRONTMATTER
|
||||||
|
|
||||||
|
Frontmatter uses the _ini_ format.
|
||||||
|
Keys and values are separated by '='.
|
||||||
|
The following keys are supported:
|
||||||
|
|
||||||
|
|[ *Key*
|
||||||
|
:[ *Description*
|
||||||
|
| title
|
||||||
|
: The title of the page
|
||||||
|
| date
|
||||||
|
: The date of the page, specified in the format "2006-01-02".
|
||||||
|
|
||||||
|
# CONFIGURATION
|
||||||
|
|
||||||
|
kiln looks for a configuration file named "config.ini".
|
||||||
|
The configuration file uses the _ini_ format.
|
||||||
|
The following keys are supported:
|
||||||
|
|
||||||
|
|[ *Key*
|
||||||
|
:[ *Description*
|
||||||
|
:[ *Default value*
|
||||||
|
| title
|
||||||
|
: Site title
|
||||||
|
: ""
|
||||||
|
| url
|
||||||
|
: Site URL
|
||||||
|
: ""
|
||||||
|
| atom
|
||||||
|
: Output an atom feed
|
||||||
|
: false
|
||||||
|
| html
|
||||||
|
: Output HTML
|
||||||
|
: false
|
||||||
|
|
Loading…
Reference in a new issue