UNK
a very small static site generator
__UNK__ is an experiment in minimalism.
It is a templating static site generator
with an included markup language
that all fits within 1000 bytes.
There are three main scripts:
- UNK (253 bytes), a POSIX-sh script that applies
the template to each page and publishes them to the output dir,
- LHT (241 bytes), an awk script that serves as
a (very) basic markup language, and
- TM (502 bytes),
the default template script for UNK.
You are, of course, free to make the template file as large
and involved as you like, but it's pretty good already:
- it has a plain default CSS
(based on this article),
or will use
S/s.css if it exists
- it automatically adds a list of posts to the index page,
or a link to other pages
- it cleans up the first line of the input file and makes it a
<title>, and a <h1>
in the generated HTML
INSTALLING & RUNNING
To install __UNK__, simply clone this repo and put it where you want it.
The default __TM__ needs __LHT__ to be in the same directory as it,
so keep that in mind.
To run __UNK__, just `cd` into your cloned repo and run `./unk`.
It's just a POSIX shell script.
DETAILS
unk
__UNK__ takes a set of files in a directory, applies a template to them,
and output them into another directory as HTML files ready for a server.
To keep a very small size, __UNK__ delegates most file processing to __TM__,
the main template. It delegates by using an idea found in
shab:
each input file is read as a `heredoc`, which enables
shell interpolation.
So the template, as opposed to the engine,
can do all the heavy-lifting of index generation and navigation and such.
Content goes into the following (hard-coded) directories:
- I/,
for written (Input) content
(the pages of the site),
- S/, for Static content
(css, images, etc.), &
- O/, for the (Output)
website, ready for
rsyncing to a server.
If there is no __TM__ in the directory where __UNK__ is run,
one will be created that will simply `cat` the file being processed.
The following variable is made available to __TM__:
- F: the File name passed to
TM
- N: the fileName
(with directories removed) of the file being processed
as well as these functions:
- X, for eXpand:
the
shab stand-in.
It is much simpler than shab,
and will fail if the template
(or if it nests templates, one of the nested ones)
has a ZZ on a line by itself,
due to its heredoc nature.
- T, for Title:
it'll return the first line of the current file.
- B, for Body:
it'll return all lines *but* the first of the current file.
and these aliases (though they're more an artefact of saving space
in the script, but they can be used in templates):
As mentioned above, templates can be nested.
Simply call another template from __TM__ with the __X__ function.
lht
__LHT__ stands for *Less HyperText*,
because that's what you're writing when you're writing it
(though not much less than HTML).
Basically,
blank lines are interpreted as <p> tag breaks,
unless the previous source paragraph started with
< and ended with >.
It also has support for three inline spans:
*em*
as em__strong__
as strong`code` as code
Everything else is just HTML.
This means that a valid `.lh` file is *almost* a valid `.md` file,
except where it nests HTML and Markdown
(so it's not really, but you can run it through Markdown in a pinch
and get the basic idea across.
This file, for example, is both `index.lh` and `README.md`
(they're just symlinked to each other),
so it's got some weirdness to keep things compatible between Markdown and LHT.
But if you're just writing for LHT, it can be much simpler.).
__LHT__ was inspired, in part, by
Writing HTML in HTML
by John Ankarstrom,
as well as some other articles I can't think of right now.
I liked the idea, but some tags in HTML are just annoying to write
over and over, and take me out of the flow of writing prose.
So I fixed those few tags.
__The inline tags are definitely subject to change.__
Why?
I was bored and decided I'd try to write a static site generator
that could fit in a
toot
(500 characters).
I
wrote
a few
of them,
making them smaller and smaller each time.
By the end, I was left with a *tiny* script
that delegated almost *all* the work to the template file.
That script became __UNK__ in this repo.
I was feeling pretty high on my horse after writing the tiny SSG,
so I thought,
maybe
I could try for a tootable Markdown converter next —
boy, was I wrong about that.
Markdown is *way* too complicated to fit in 500 bytes.
So I just wrote the Really Important Parts: <p>
and some inlines.
LEGAL
Copyright © 2019 Case Duckworth
<acdw@acdw.net>.
This work is free.
You can redistribute it and/or modify it under the terms of
the Do What The Fuck You Want To Public License, Version 2,
as published by Sam Hocevar.
See the LICENSE
file for more details.
Why this license?
I was going to go with a stricter license like the GPL,
but realized that
- this software isn't so important or time-consuming that I need
others to credit me or redistribute the project under the same terms,
and
- the GPL is way too long for a project like this.
It's over 35 times bigger than the entirety of this project,
not counting the content or this README.
It would weigh down the entire undertaking.
The WTFPL, by contrast, is a trim 443 characters,
which is right in keeping with the smallness of this project.
CONTRIBUTING
To contribute to this project,
head over to its GitHub mirror
and send me a pull request or issue.
One of these days, I'm sure I'll figure out sr.ht's mailing lists,
