CYBERTEC Geekdoc

A CYBERTEC themed fork of geekdoc, a Hugo theme made for documentation.

---

Requirements

• go
• hugo

Usage

Initialize a new hugo site:

hugo new site <site-name>
cd <site-name>

Initialize the site as a go module:

hugo mod init github.com/cybertec-postgresql/<repository-name>

Add the following to your hugo.toml to use this theme, including functional code-highlighting:

# hugo.toml
pygmentsCodeFences = true
pygmentsUseClasses = true

[module]
[[module.imports]]
path = 'github.com/cybertec-postgresql/hugo-geekdoc'

Fetch the module

hugo mod get -u

Build your page

hugo --minify
# You may optionally overwrite the `baseURL`
hugo --minify -b "/docs/"

Update

To retrieve the latest version of this theme, simply run

hugo mod get -u
hugo mod tidy

Development

The fork and source code is located inside the dev branch. On push, a GitHub Actions workflow will build and push the release to the main branch.

Sync fork

git checkout dev
git rebase upstream/main
git push --force

---

The contents below are from the original Geekdoc README.

---

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.

Build and release process

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 and bundled in a release tarball. You can download the latest release from the GitHub release page.

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.

# install required packages from package.json
npm install

# run the build script to build required assets
npm run build

# build release tarball
npm run pack

See the Getting Started Guide for details about the different setup options.

Contributors

Special thanks to all contributors. If you would like to contribute, please see the instructions.

Geekdoc is inspired and partially based on the hugo-book theme, thanks Alex Shpak for your work.

License

This project is licensed under the MIT License - see the LICENSE file for details.

The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack:

• Font Awesome: CC BY 4.0 License
• IcoMoon Free Pack: GPL/CC BY 4.0
• Material Icons: Apache License 2.0