gemini/README.md
2025-08-22 10:09:58 -05:00

39 lines
1.4 KiB
Markdown

# ~snit
The source files for my personal capsule, which can be viewed at:
[=> Capsule (HTTPS)](https://isekai.rocks/~snit)
[=> Capsule (Gemini)](gemini://isekai.rocks/~snit)
This capsule relies on STXGE, which is a static site generator I wrote myself
using Guile Scheme. STXGE takes in source files written in Scheme, evaluates
them to produce SGT(akin to SXML for GemText), then renders the SGT to XHTML
and GemText.
[=> STXGE Repository](https://forge.fsky.io/snit/stxge)
[=> SXML on Wikipedia](https://en.wikipedia.org/wiki/SXML)
## Building
The `Makefile` includes variables up top that may be messed with, such as paths
to the STXGE tools if they aren't on your `${PATH}`.
To build this capsule, you can run any of the following:
```
$ make # Build everything
$ make gmi # Only build for Gemini
$ make web # Only build for HTTP(S)
$ make clean # Delete rendered GMI/XHTML
$ make distclean # Delete all build files
$ make wwwsrv # Run a web server via Python
```
By default, the following directories are used:
* `site/` contains document templates to render
* `incl/` contains templates that can be included to provide code or data
* `asst/` contains asset files such as media or stylesheets
* `build/sgt/` will contain intermediary SGT data from evaluating templates
* `build/sxml/` will contain intermediary SXML data, translated from the SGT
* `dist/{www,gmi}/` will contain rendered XHTML and GemText documents, respectively