docs: Update README
This commit is contained in:
parent
4294ca098c
commit
1f2b49ba3f
29
README.md
29
README.md
@ -4,15 +4,7 @@ See the live website at [moxxy.org](https://moxxy.org).
|
|||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Developing the site requires [jekyll](https://jekyllrb.com/) and [tailwindcss](https://tailwindcss.com/).
|
Developing the site requires [zola](https://www.getzola.org/) 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.
|
|
||||||
|
|
||||||
### Tailwind
|
### Tailwind
|
||||||
|
|
||||||
@ -25,20 +17,23 @@ required for building the website.
|
|||||||
|
|
||||||
In order to test changes, assuming jekyll and tailwindcss are set up, ...
|
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.
|
1. Run `tailwindcss -c tailwind.config.js -i input.css --watch --output ./static/css/index.css` from the root of the repository.
|
||||||
2. Run `jekyll serve` 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.
|
previews when modifying their files.
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
|
|
||||||
In order to build the website, you can either use the NixOS flake at the root
|
1. `tailwindcss --input ./input.css --output ./static/css/index.css`
|
||||||
of the repository (`nix build .#website`) or build the website and CSS separately:
|
2. `zola build`
|
||||||
|
|
||||||
1. `jekyll build --future`
|
### Adding a Blog Post
|
||||||
2. `cp -r ./assets _site/assets`
|
|
||||||
3. `tailwindcss --input ./input.css --output ./_site/assets/css/index.css`
|
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
|
## License
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user