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-04-20 21:37:05 -04:00
parent 20efed1e9a
commit 38439877b9
1 changed files with 4 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/kiln.1.scd
View file

@ -35,24 +35,18 @@ kiln - a simple static site generator
# OVERVIEW # OVERVIEW
A kiln site is built in one or more steps called _tasks_. A kiln site is built in one or more steps called _tasks_.
Tasks read content from the content directory, process the content, and write
the content to the output directory. Tasks can also be configured to copy static
content to the output directory.
There is only one default task called "gemini" which builds a Gemini site. The following directories are common to all tasks:
The following directories are used by default:
|[ *Directory* |[ *Directory*
:[ *Description* :[ *Description*
| content/ | content/
: Content directory : Content directory
| static/
: Static content directory
| templates/ | templates/
: Template directory : Template directory
| public/
: Output directory
Tasks can be configured to use different static content and output directories.
The content and template directories are shared between tasks.
# CONFIGURATION # CONFIGURATION