updated README

This commit is contained in:
Kristian Krsnik 2023-08-18 22:32:57 +02:00
parent 6737d9981c
commit 31a8f290b4

View File

@ -1,12 +1,16 @@
# Kristian's Reproducible Website
[![GitHub Pages Status](https://github.com/Krsnik/blog/actions/workflows/blog.yaml/badge.svg)](https://github.com/Krsnik/blog/actions/workflows/blog.yaml)
This project is my personal website, using Hugo with asciidoc as a static site generator.
The site is hosted on GitLab pages, using the supplied `.gitlab-ci.yaml` file, which just builds the `flake.nix` file.
## Development
To preview changes serve the website with `hugo serve` and set `draft: false` in your blogpost.
To preview changes serve the website with `hugo serve -D`. This will build all content that has `draf: true` set in the header.
This will also build the theme's content, if it includes one.
If you are only interested how the published site will look do `hugo serve`.
## Deployment
Just push the changes to GitLab and the automatic CI/CD will build and deploy the website.
This repo includes CI/CD configurations for GitHub and GitLab, so all you need to do is push any changes.