moxxy/website
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update README

Browse Source
This commit is contained in:
PapaTutuWawa 2024-01-13 13:38:07 +01:00
parent 4294ca098c
commit 1f2b49ba3f
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -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-<Title>`. 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