This repository contains the source code for the Kluctl website. It uses the docsy theme. A development environment can be set up locally or by using GitHub Codespaces.
Ensure the following prerequisites are met.
Note: The Hugo extended version is required for various purposes (like transforming SCSS to CSS, converting images to
webpformat). Without it, you may encounter the following error message:
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
-
Clone the repository
git clone [email protected]:kluctl/www-kluctl.io.git cd www-kluctl.io
-
Run Hugo server:
hugo server
Note: The first run might take a while as Hugo modules are fetched.
-
Open your web browser and go to
http://localhost:1313to preview the Kluctl website.
For GitHub Codespaces, no additional setup is needed. Follow these steps:
-
Start a codespace in the
mainbranch using GitHub UI. -
Start the Hugo server using the following command:
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.