readme.md

# strom-roku-2023.krk-litvinov.cz

This directory contains the full source code for <https://strom-roku-2023.krk-litvinov.cz>. The content is mostly written in [CommonMark](https://commonmark.org/) and converted into HTML with `site`, a custom [static site generator](https://en.wikipedia.org/wiki/Static_site_generator) based on [hakyll](https://jaspervdj.be/hakyll/).

The project is structured as follows:

- `content/` – actual content of the site (articles, news posts, photos and other files for downloading).
  - `content/novinky/` – news posts.
- `static/` – files used as a part of the layout (styles, scripts, images aside from content…), mostly kept as they are.
- `templates/` – building blocks for generating the HTML.
- `site/` – source code of the `site` program.

The revision history is tracked using [Git](https://git-scm.com/), with up-to-date version available on <https://code.ogion.cz/tojnar.cz/strom-roku-2023.krk-litvinov.cz>. Pushing into the `main` branch of the repository will automatically update the live version of the website.

## Usage

The `site` program needs to be run in this directory. It supports the following subcommands:

- `site build` – produces a `public/` directory with the website to be viewed in a web browser or uploaded to the server. If source content changes, only the pages corresponding to changed files will be updated.
- `site rebuild` – cleans the `public/` directory and then runs the `build` subcommand.
- `site watch` – starts a web server that will serve the built website and automatically rebuild pages corresponding to changed files. While it is running, you can browse the site on <http://localhost:8000>.
- `site check` – checks for broken links in the generated website.

### UNIX

The project uses [Nix](https://nixos.org) package manager to build the `site` program. Run `nix-shell` to enter a shell containing `site` program for controlling the website.

If you have [`direnv`](https://direnv.net/) installed, you can instead run `direnv allow` and it will prepare the correct shell environment automatically every time you enter the directory.
-												Initial commit

											
										
										
											2023-05-04 23:16:34 +02:00
+								# strom-roku-2023.krk-litvinov.cz
 								This directory contains the full source code for <https://strom-roku-2023.krk-litvinov.cz>. The content is mostly written in [CommonMark](https://commonmark.org/) and converted into HTML with `site`, a custom [static site generator](https://en.wikipedia.org/wiki/Static_site_generator) based on [hakyll](https://jaspervdj.be/hakyll/).
 								The project is structured as follows:
 								- `content/` – actual content of the site (articles, news posts, photos and other files for downloading).
 								  - `content/novinky/` – news posts.
 								- `static/` – files used as a part of the layout (styles, scripts, images aside from content…), mostly kept as they are.
 								- `templates/` – building blocks for generating the HTML.
 								- `site/` – source code of the `site` program.
 								The revision history is tracked using [Git](https://git-scm.com/), with up-to-date version available on <https://code.ogion.cz/tojnar.cz/strom-roku-2023.krk-litvinov.cz>. Pushing into the `main` branch of the repository will automatically update the live version of the website.
 								## Usage
 								The `site` program needs to be run in this directory. It supports the following subcommands:
 								- `site build` – produces a `public/` directory with the website to be viewed in a web browser or uploaded to the server. If source content changes, only the pages corresponding to changed files will be updated.
 								- `site rebuild` – cleans the `public/` directory and then runs the `build` subcommand.
 								- `site watch` – starts a web server that will serve the built website and automatically rebuild pages corresponding to changed files. While it is running, you can browse the site on <http://localhost:8000>.
 								- `site check` – checks for broken links in the generated website.
 								### UNIX
 								The project uses [Nix](https://nixos.org) package manager to build the `site` program. Run `nix-shell` to enter a shell containing `site` program for controlling the website.
 								If you have [`direnv`](https://direnv.net/) installed, you can instead run `direnv allow` and it will prepare the correct shell environment automatically every time you enter the directory.