kiln/README.md

40 lines
722 B
Markdown
Raw Normal View History

2019-05-18 18:00:12 +00:00
# kiln
2021-04-12 02:36:16 +00:00
A simple static site generator.
2019-05-18 18:00:12 +00:00
2021-06-26 06:09:15 +00:00
[Tutorial](https://kiln.adnano.co)
2019-05-18 18:00:12 +00:00
## Features
2021-04-12 02:36:16 +00:00
- Simple
- Extensible
2020-09-22 20:42:14 +00:00
- Gemini support
2020-11-27 23:26:36 +00:00
- Atom feeds
2020-09-22 20:42:14 +00:00
- Go templates
2019-05-18 18:00:12 +00:00
## Installation
2020-11-11 00:34:05 +00:00
First install the dependencies:
- Go 1.16 or later
2020-11-11 00:34:05 +00:00
- scdoc
2020-11-02 01:51:43 +00:00
Then compile:
$ make
# make install
2019-05-18 18:00:12 +00:00
## Usage
2020-11-11 00:34:05 +00:00
See kiln(1)
2021-06-26 06:09:15 +00:00
For a general introduction, see the [website](https://kiln.adnano.co).
2020-11-11 00:34:05 +00:00
## Contributing
For end-user discussion and questions, start a thread on [~adnano/kiln-discuss](https://lists.sr.ht/~adnano/kiln-discuss).
2022-12-03 19:57:13 +00:00
Send patches to [~adnano/kiln-devel](https://lists.sr.ht/~adnano/kiln-devel) with prefix `PATCH kiln`.
2019-05-18 18:00:12 +00:00
2020-11-11 00:34:05 +00:00
Subscribe to release announcements on [~adnano/kiln-announce](https://lists.sr.ht/~adnano/kiln-announce).