From bf4233f389bacd3e7cee7f591403ea8cea6eb56c Mon Sep 17 00:00:00 2001 From: cos Date: Fri, 15 Sep 2023 10:23:46 +0200 Subject: Increase unrendered readability of README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f125089..2fd4384 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,25 @@ # Copenhagen Rust Community website -Static site built with Zola. +Static site built with [Zola][]. ## Updating an event -The `events.toml` file stores all the events. Edit the file in a pull request (using the GitHub web editor is fine). Once merged, the site will automatically deploy a new version. +The `events.toml` file stores all the events. Edit the file in a pull request +(using the GitHub web editor is fine). Once merged, the site will automatically +deploy a new version. ## Local development 1. Clone the repository. -1. [Install](https://www.getzola.org/documentation/getting-started/installation/) Zola. +2. [Install][] Zola. -1. Run the site in preview mode: +3. Run the site in preview mode: zola serve -Note: The `events.toml` file is only loaded on startup and changes to it will not trigger live reload. \ No newline at end of file +Note: The `events.toml` file is only loaded on startup and changes to it will +not trigger live reload. + +[Zola]: https://www.getzola.org/documentation/getting-started/overview/ +[Install]: https://www.getzola.org/documentation/getting-started/installation/ \ No newline at end of file -- cgit v1.2.3