website/README.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2023-05-05 18:39:45 +00:00
# Moxxy's Website
See the live website at [moxxy.org](https://moxxy.org).
## Development
2024-01-13 12:38:07 +00:00
Developing the site requires [zola](https://www.getzola.org/) and [tailwindcss](https://tailwindcss.com/).
2023-05-05 18:39:45 +00:00
### 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, ...
2024-01-13 12:38:07 +00:00
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.
2023-05-05 18:39:45 +00:00
2024-01-13 12:38:07 +00:00
This gives you an environment where tailwindcss and zola regenerate their
2023-05-05 18:39:45 +00:00
previews when modifying their files.
### Building
2024-01-13 12:38:07 +00:00
1. `tailwindcss --input ./input.css --output ./static/css/index.css`
2. `zola build`
### Adding a Blog Post
If you want to add a blog post, considert the following:
2023-05-05 18:39:45 +00:00
2024-01-13 12:38:07 +00:00
- 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.
2023-05-05 18:39:45 +00:00
2024-01-13 12:44:09 +00:00
Note that the existing posts specify an alias as this site has been migrated from jekyll to zola. It is not required for new posts.
2023-05-05 18:39:45 +00:00
## License
See [`./LICENSE`](./LICENSE)