From 1f2b49ba3fcad44be41f30bc0351cd76d8643fde Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Sat, 13 Jan 2024 13:38:07 +0100 Subject: [PATCH] docs: Update README --- README.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 696df51..c277b5c 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,7 @@ See the live website at [moxxy.org](https://moxxy.org). ## Development -Developing the site requires [jekyll](https://jekyllrb.com/) and [tailwindcss](https://tailwindcss.com/). - -### Jekyll - -This website is statically generated using jekyll. Besides jekyll, the two -jekyll plugins [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) and [jekyll-feed](https://github.com/jekyll/jekyll-feed) must be installed. - -See [here](https://jekyllrb.com/docs/plugins/installation/) for instructions -on installing plugins. +Developing the site requires [zola](https://www.getzola.org/) and [tailwindcss](https://tailwindcss.com/). ### Tailwind @@ -25,20 +17,23 @@ required for building the website. In order to test changes, assuming jekyll and tailwindcss are set up, ... -1. Run `tailwindcss -c tailwind.config.js -i input.css --watch --output ./_site/assets/css/index.css` from the root of the repository. -2. Run `jekyll serve` from the root of the repository. +1. Run `tailwindcss -c tailwind.config.js -i input.css --watch --output ./static/css/index.css` from the root of the repository. +2. Run `zola serve` from the root of the repository. -This gives you an environment where tailwindcss and jekyll regenerate their +This gives you an environment where tailwindcss and zola regenerate their previews when modifying their files. ### Building -In order to build the website, you can either use the NixOS flake at the root -of the repository (`nix build .#website`) or build the website and CSS separately: +1. `tailwindcss --input ./input.css --output ./static/css/index.css` +2. `zola build` -1. `jekyll build --future` -2. `cp -r ./assets _site/assets` -3. `tailwindcss --input ./input.css --output ./_site/assets/css/index.css` +### Adding a Blog Post + +If you want to add a blog post, considert the following: + +- If the post should contain media, create a directory in `./content/blog/` with the following naming scheme `YYYY-MM-DD-`. Inside that directory, create an `index.md` file where you can write the post in Markdown. The media files can then be placed inside that directory and included using `![](file-name.ext)`. +- If the post does not contain media, create a file in `./content/blog/` with the following naming scheme `YYYY-MM-DD-<Title>`. Inside that file you can write the post in Markdown. ## License