Simple markdown based low bandwidth static site generator
Project description
PyStatisk
A Python port of the Kotlin Statisk project, designed to run on low power devices (RaspberryPi Zero). Converts Markdown files to simple Html with image size reduction for extreme low-bandwidth web pages.
Install
Install via PIP:
pip install Statisk
then run with:
stsk /path/to/blog/
If you encounter an error when running stsk similar to:
ImportError: libopenjp2.so.7: cannot open shared object file: No such file or directory
execute the following to fix: sudo apt-get install libopenjp2-7-dev
Setup
_template.html should be placed in root directory of the website, simple example:
<!DOCTYPE html>
<html>
<head>
<!-- Optional -->
<title>{{ title }}</title>
</head>
<body>
{{ content }}
<footer>
<!-- Optional -->
{{ page_size }}
</footer>
</body>
</html>
Blog Structure
Markdown posts need to be in a Year/Month/Day (YYYY/MM/DD) structure inside a root posts/ directory:
|- _template.html
|- posts/
|- 2020/
|- 01/
|-20/
|- index.md
|- picture.png
|-15/
|- index.md
|- 2019/
|- 12/
|-24/
|- index.md
|- pictureA.png
|- pictureB.png
Style Parameters
Markdown posts can set parameters to override how images are handled and to set the page background, this is done using a hidden comment at the top of the markdown file, eg:
<!--- -algorithm 5by3Bayer -threshold 100 -background #efefef -image_foreground #002233 -image_background #dedede -->
| Argument | Behaviour |
|---|---|
-algorithm |
Sets dither algorithm (see below), eg. -algorithm stucki |
-threshold |
Set threshold of dither algorithms in range 0 to 255, eg. -threshold 255 |
-image_foreground |
Set the foreground colour of dithered images, eg. -image_foreground #002233 |
-image_background |
Set the background colour of dithered images, eg. -image_background #ffcdcd |
-background |
Override the page background colour, eg. -background #efefef |
Dithering
Available dithering algorithms (from DitherKt):
2by2Bayer, 3by3Bayer, 4by4Bayer, 5by3Bayer, 8by8Bayer, FloydSteinberg, FalseFloydSteinberg, NewspaperHalftone, JarvisJudiceNinke, Sierra, SierraLite, TwoRowSierra, Burkes, Atkinson, Stucki, ErrorDif, Threshold, Random
there's also a greyscale filter (-algorithm greyscale), threshold is ignored.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
