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 documentation

Browse source
This commit is contained in:
adnano 2021-05-10 15:09:23 -04:00
parent de6b0258fc
commit bd3ffe23d9
1 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/kiln.1.scd
View file

@ -6,9 +6,7 @@ kiln - a simple static site generator
# SYNOPSIS
*kiln* build++
[-c _config_]++
[-t _task_]
*kiln* build [-c _config_]
*kiln* new _path_
@ -20,7 +18,7 @@ kiln - a simple static site generator
*kiln new* creates a new kiln site at the given path.
*kiln version* prints version information for the *kiln* program.
*kiln version* prints version information for the kiln program.
# OPTIONS
@ -29,9 +27,6 @@ kiln - a simple static site generator
*-c* _config_
Specifies the configuration file to use. Defaults to "config.toml".
*-t* _task_
Specifies the task to run. If unspecified, all tasks will be run.
# OVERVIEW
A kiln site is built in one or more steps called *tasks*.
@ -213,7 +208,7 @@ command to convert Gemini text to HTML.
```
# Build the site
[tasks.gemini]
[[tasks]]
input = [".gmi"]
output = ".gmi"
template = ".gmi"
@ -221,7 +216,7 @@ command to convert Gemini text to HTML.
output_dir = "public"
# Export an HTML version of the site
[tasks.exporthtml]
[[tasks]]
input = [".gmi"]
output = ".html"
template = ".gmi"
@ -235,7 +230,7 @@ content directory and HTML templates in the templates directory. This
configuration makes use of the *markdown*(1) comand to convert Markdown to HTML.
```
[tasks.markdowntohtml]
[[tasks]]
input_ext = [".md"]
output_ext = ".html"
template_ext = ".html"