From 19f9db1721be1d57e957932547aace742017a674 Mon Sep 17 00:00:00 2001 From: Winston Smith Date: Sat, 18 Nov 2023 16:39:08 +0100 Subject: [PATCH] chore: add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec08fee --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Dockerized Jekyll + +## Presentation + +A dynamicaly configurable [Jekyll](https://jekyllrb.com) container. +I Needed a static site generator which I could put in container I found Jekyll. +Alas, existing containers available on the net where either too old or too complex for my understanding. +Counting on my modest shell scripting skills, I managed to give life to an abomination working mainly by the mighty will of GNU sed. + +## How to use it ? + +- Edit `./data/.env` to fit your needs. +- Create `./data/_description.txt`, with the wanted website description. + **Be carefull to remove whitespaces at line start**. It will not properly indented when put in the `_config.yml`, fudging up the description format. +- Build the image via the provided `docker-compose.yml` file. +- Run the service. + +Variables in .env and the site description are updated at container restart. +**Keep in mind that changing your site name (with `BLOG_NAME` var) will fudge up all reference files (site description, site path etc.).** + +## Disclaimer + +This software is provided as-is and is the offspring of a humble sysadmin mind, constantly learning new things. +It will be improved the time beeing.