Temp

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -1,46 +1,68 @@
-# Geekdoc
+# Hugo documentation
 
-[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)
-[![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)
-[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)
-[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)
-[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
+A CYBERTEC themed "fork" of the [geekdoc](https://github.com/thegeeklab/hugo-geekdoc) theme for hugo.
 
-Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of good alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
+## Requirements
 
-![Desktop and mobile preview](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/images/readme.png)
+- `go`
+- `hugo`
 
-## Build and release process
+## Usage
 
-This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by [webpack](https://webpack.js.org/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekdoc/releases).
+Initialize a new hugo site:
 
-Due to the fact that `webpack` and `npm scripts` are used as pre-processors, the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `webpack` locally and run the build script once to create all required assets.
+```shell
+hugo new site <site-name>
+cd <site-name>
+```
+
+Initialize the site as a go module:
 
 ```shell
-# install required packages from package.json
-npm install
+hugo mod init github.com/cybertec-postgresql/<repository-name>
+```
+
+Add the following to your `hugo.toml` to use this theme, including functional code-highlighting:
+
+```toml
+# hugo.toml
+pygmentsCodeFences = true
+pygmentsUseClasses = true
+
+[module]
+[[module.imports]]
+path = 'github.com/cybertec-postgresql/hugo_documentation'
+```
 
-# run the build script to build required assets
-npm run build
+Fetch the module
 
-# build release tarball
-npm run pack
+```shell
+hugo mod get -u
 ```
 
-See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for details about the different setup options.
+Build your page
+```shell
+hugo --minify
+# You may optionally overwrite the `baseURL`
+hugo --minify -b "/docs/"
+```
 
-## Contributors
+## Update
 
-Special thanks to all [contributors](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/hugo-geekdoc/blob/main/CONTRIBUTING.md).
+To retrieve the latest version of this theme, simply run
+
+```shell
+hugo mod get -u
+hugo mod tidy
+```
 
-Geekdoc is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme, thanks [Alex Shpak](https://github.com/alex-shpak/) for your work.
+## "Fork"
 
-## License
+This repository uses the built release, taken from https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz.
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE) file for details.
+The following customizations have been done to achieve a CYBERTEC look and feel:
 
-The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack:
+- Use the CYBERTEC logo in `./static/brand.svg`
+- Add the `./config/_default/hugo.toml` config
 
-- Font Awesome: [CC BY 4.0 License](https://github.com/FortAwesome/Font-Awesome#license)
-- IcoMoon Free Pack: [GPL/CC BY 4.0](https://icomoon.io/#icons-icomoon)
-- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/main/LICENSE)
+In case that `geekdoc` is updated, we will have to fetch the latest release, merge those files into this repository, and handle possible merge conflicts.

VERSION

@@ -1 +1 @@
-v0.47.0
+v0.48.0