From e24fbab7e92eb0c35d88df8b22257ad523b5cdf7 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Thu, 16 Jan 2025 22:11:25 +0100 Subject: [PATCH] docs: Re-Added Readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..57d1315 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# @lfk/documentation + +The documentation for the LfK! 'Läufersystem'. +Powered by Hugo. + +The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school) but every page has an English translation. + +## Quickstart 🐳 + +> Use this to run the documentation server via docker. + +1. Clone the repo or copy the docker-compose.yml +2. Cd into the folder containing the docker-compose.yml +3. Run docker-compose: `docker-compose up -d` +4. Visit to check if the server is running + +## Dev Setup 🛠 + +> Local dev setup for previewing changes. + +1. Clone the repo +2. Install Hugo: `brew install hugo` or `winget install hugo.hugo.extended` +3. Start the dev server: `hugo server --buildDrafts --disableFastRender` + +### Recommended Editor + +[Visual Studio Code](https://code.visualstudio.com/)