chore: add readme

This commit is contained in:
Winston Smith 2023-11-18 16:39:08 +01:00
parent e0ad92c9be
commit 19f9db1721

24
README.md Normal file
View File

@ -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/<blog_name>_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.