lfk/docs
3
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

docs: Re-Added Readme

Browse Source
This commit is contained in:
Nicolai Ort 2025-01-16 22:11:25 +01:00
parent 74b4139b8d
commit e24fbab7e9
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file
View File

@ -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 <http://127.0.0.1:8080/> 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/)