On this page
Getting started
Check out the website and theme and run your first preview.
Prerequisites
- Git.
- Hugo extended 0.168.0.
- Go 1.27.3 for the theme’s Bootstrap dependency.
- Read access to the theme and any product repositories you want to preview.
Check out the site and theme
git clone git@github.com:KYANIS-GmbH/kyanis-docs.git
git clone git@github.com:KYANIS-GmbH/kyanis-hugo-theme.git
cd kyanis-docs
hugo server --themesDir ../
Open http://localhost:1313/en/. English lives under /en/ and German under
/de/. The root URL redirects to English.
The --themesDir ../ argument tells Hugo to use the sibling theme checkout.
No theme Git submodule or remote theme module import is needed. The Bootstrap
module dependency is resolved using this repository’s go.mod and go.sum.
Where to edit
- Website authoring guide:
content/en/guide/in this repository. - English product pages:
src/docs/en/in the product repository. - German product pages:
src/docs/de/in the product repository. - Shared presentation: the separate
kyanis-hugo-themerepository.
Do not edit fetched copies in _sources/; they are generated inputs.