Maxim Taran 7b05708a58 Updated geekdoc. 1 month ago
..
.github 7b05708a58 Updated geekdoc. 1 month ago
.gitsv 7b05708a58 Updated geekdoc. 1 month ago
.woodpecker 7b05708a58 Updated geekdoc. 1 month ago
archetypes 8710a66ab1 Changed theme to geekdoc 2 years ago
assets eb42615352 Upgraded hugo-geekdoc to v0.46.0 5 months ago
data eb42615352 Upgraded hugo-geekdoc to v0.46.0 5 months ago
exampleSite 7b05708a58 Updated geekdoc. 1 month ago
i18n 7b05708a58 Updated geekdoc. 1 month ago
images 8a82cffa19 Upgraded geekdoc to v0.39.1 1 year ago
layouts 7b05708a58 Updated geekdoc. 1 month ago
src 7b05708a58 Updated geekdoc. 1 month ago
static eb42615352 Upgraded hugo-geekdoc to v0.46.0 5 months ago
.dictionary 7b05708a58 Updated geekdoc. 1 month ago
.gitignore 7b05708a58 Updated geekdoc. 1 month ago
.htmlvalidate.json 7b05708a58 Updated geekdoc. 1 month ago
.jsbeautifyrc 7b05708a58 Updated geekdoc. 1 month ago
.lighthouserc.yml 7b05708a58 Updated geekdoc. 1 month ago
.lycheeignore 7b05708a58 Updated geekdoc. 1 month ago
.markdownlint.yml 7b05708a58 Updated geekdoc. 1 month ago
.npmrc 7b05708a58 Updated geekdoc. 1 month ago
.nvmrc 7b05708a58 Updated geekdoc. 1 month ago
.prettierignore 7b05708a58 Updated geekdoc. 1 month ago
.prettierrc 7b05708a58 Updated geekdoc. 1 month ago
.tarignore 7b05708a58 Updated geekdoc. 1 month ago
CONTRIBUTING.md 7b05708a58 Updated geekdoc. 1 month ago
LICENSE 8710a66ab1 Changed theme to geekdoc 2 years ago
README.md 7b05708a58 Updated geekdoc. 1 month ago
VERSION eb42615352 Upgraded hugo-geekdoc to v0.46.0 5 months ago
eslint.config.js 7b05708a58 Updated geekdoc. 1 month ago
package-lock.json 7b05708a58 Updated geekdoc. 1 month ago
package.json 7b05708a58 Updated geekdoc. 1 month ago
renovate.json 7b05708a58 Updated geekdoc. 1 month ago
svgsprite.config.json 7b05708a58 Updated geekdoc. 1 month ago
theme.toml 7b05708a58 Updated geekdoc. 1 month ago
webpack.config.js 7b05708a58 Updated geekdoc. 1 month ago
webpack.plugins.js 7b05708a58 Updated geekdoc. 1 month ago

README.md

Geekdoc

Build Status Hugo Version GitHub release GitHub contributors

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.

Desktop and mobile preview

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: