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
kiln/README.md
adnano 2bbfdc3d07 Reimplement in Go
2020-09-22 16:42:14 -04:00

1.2 KiB
Raw Blame History

kiln

A simple static site generator for Gemini.

Features

  • Zero configuration
  • Simple and fast
  • Gemini support
  • Go templates

Usage

kiln

Directory Structure

A kiln site is organized in the following way:

src/				Site source
templates/ 			Templates
	page.gmi		Page template
	section.gmi 	Section template
dst/				Site destination

Running kiln takes the contents in src, runs them through the templates in templates, and outputs the result to dst.

Pages

Page templates are provided with the following information:

  • Title: The title parsed from the first heading in the file
  • Date: The date parsed from the filename (e.g. 2020-09-22-hello-world.gmi)
  • Path: Relative path to the page
  • Permalink: Permalink to the page
  • Content: The contents of the file (including the title)

Sections

Section templates are provided with the following information:

  • Path: Relative path to the section
  • Permalink: Permalink to the section
  • Pages: The pages in this section

Templates

Templates are located in the templates directory.

There are currently two supported templates:

  • page.gmi: The template used for pages
  • section.gmi: The template used for sections