https://github.com/kluctl/www-kluctl.io
The home of the kluctl.io website and documentation.
https://github.com/kluctl/www-kluctl.io
Last synced: 6 days ago
JSON representation
The home of the kluctl.io website and documentation.
- Host: GitHub
- URL: https://github.com/kluctl/www-kluctl.io
- Owner: kluctl
- Created: 2022-04-01T07:09:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-31T09:59:00.000Z (3 months ago)
- Last Synced: 2026-05-17T02:03:51.662Z (29 days ago)
- Language: CSS
- Homepage: https://kluctl.io
- Size: 29.8 MB
- Stars: 6
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kluctl website
This repository contains the source code for the Kluctl website. It uses the [docsy](https://www.docsy.dev/) theme. A development environment can be set up locally or by using GitHub Codespaces.
## Local Development
### Requirements
Ensure the following prerequisites are met.
- [Go](https://go.dev/dl/) (Golang) version: `1.21.3`
- [Hugo](https://gohugo.io/installation/) extended version: `0.120.4`
> **Note:**
The Hugo extended version is required for various purposes (like transforming SCSS to CSS, converting images to `webp` format). Without it, you may encounter the following error message:
```text
error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
We release two set of binaries for technical reasons. The extended version is not what you get by default for some installation methods. On the release page, look for archives with extended in the name. To build hugo-extended, use go install --tags extended
```
### Setup
1. Clone the repository
```bash
git clone git@github.com:kluctl/www-kluctl.io.git
cd www-kluctl.io
```
2. Run Hugo server:
```bash
hugo server
```
Note: The first run might take a while as Hugo modules are fetched.
3. Open your web browser and go to `http://localhost:1313` to preview the Kluctl website.
## Podman container
If you don't want to install the dependencies locally, you can run hugo in podman:
```bash
podman build -t hugo-ext .
podman run --rm -it -v $(pwd):/src \
-v $(pwd)/.cache:/root/.cache \
-p 1313:1313 hugo-ext server --bind 0.0.0.0
```
## GitHub Codespaces
For GitHub Codespaces, no additional setup is needed. Follow these steps:
1. Start a codespace in the `main` branch using GitHub UI.
2. Start the Hugo server using the following command:
```bash
npm run dev-cp
```
This will start the Hugo server. The server URL will be shown as a notification in codespace. It can also be found ny navigating to the PORTS section of the terminal pane.
Feel free to explore and contribute to the Kluctl website. If you encounter any issues or have questions, please create an issue.