1
0
Fork 0
website/README.md
Wachtl Enterprises LLC aa11108646 Add deployment section to README
Signed-off-by: Wachtl Enterprises LLC <tyrolyean@escpe.net>
2025-01-21 11:46:36 +01:00

55 lines
1.5 KiB
Markdown

# ITS-Website
```text
it-syndikat.org
▀███▀ ███ ▄██▀██▄
▓██ ███ ▓██ ███
▒▓█ ▄▓██▄ ▒▓█▄▄▄▄
▄▄▄ ███ ▄▄▄ ███
· ▓██ ▓██ ▓██ ▓██ ·
▒██ ▒██ ▒██ ▒██
░▒█ ░▒█ ░▒█ ░▒█
▄▄▄ ▄▄▄ ▄▄▄▄▄▄▄
▄███▄ ███ ▀█dH.█▀
glory to the syndicate
```
## About
This repository contains the <https://it-syndikat.org> or
<https://www.it-syndikat.org> website, whichever one floats your boat higher.
## Edit the site
## Dependencies
- hugo
- git
- git-lfs
- Golang (for hugo modules)
After installing *git-lfs* run `git lfs install` once to make it available
system-wide.
### Cloning
This site uses git submodules and lfs. Clone this repo with `--recursive` or
run `git submodule init && git submodule update` after cloning for submodule
availability. If you had git-lfs installed already, you should be good to go,
if not, you need to run `git lfs pull`.
### Testing
This site was built using [Hugo](https://gohugo.io/). To preview the site while
editing it, you can use the `hugo server` command.
To build it locally run `hugo build`.
### Deployment
This website is auto deployed using a forgejo runner and forgejo actions. A
testing step including a linter has been included to prevent the pipeline from
deploying broken sites. If you changes do not deploy, please check the
actions tab.