From 0e6ae295766344a047840d8d08ce0f59519d0454 Mon Sep 17 00:00:00 2001 From: "Alexander \"PapaTutuWawa" Date: Fri, 5 May 2023 20:39:45 +0200 Subject: [PATCH] docs: Add build and dev instructions --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7782b17 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Moxxy's Website + +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](#) and [jekyll-feed](#) must be installed. + +See [here](https://jekyllrb.com/docs/plugins/installation/) for instructions +on installing plugins. + +### Tailwind + +The website uses tailwindcss for layouting. To use tailwind, install the +[tailwindcss CLI application](https://tailwindcss.com/docs/installation). +The [typography plugin](https://tailwindcss.com/docs/typography-plugin) is +required for building the website. + +### Previewing + +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. + +This gives you an environment where tailwindcss and jekyll 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. `jekyll build --future` +2. `cp -r ./assets _site/assets` +3. `tailwindcss --input ./input.css --output ./_site/assets/css/index.css` + +## License + +See [`./LICENSE`](./LICENSE)