Maxim Taran 7b05708a58 Updated geekdoc. hai 1 mes
..
.github 7b05708a58 Updated geekdoc. hai 1 mes
.gitsv 7b05708a58 Updated geekdoc. hai 1 mes
.woodpecker 7b05708a58 Updated geekdoc. hai 1 mes
archetypes 8710a66ab1 Changed theme to geekdoc %!s(int64=2) %!d(string=hai) anos
assets eb42615352 Upgraded hugo-geekdoc to v0.46.0 hai 5 meses
data eb42615352 Upgraded hugo-geekdoc to v0.46.0 hai 5 meses
exampleSite 7b05708a58 Updated geekdoc. hai 1 mes
i18n 7b05708a58 Updated geekdoc. hai 1 mes
images 8a82cffa19 Upgraded geekdoc to v0.39.1 hai 1 ano
layouts 7b05708a58 Updated geekdoc. hai 1 mes
src 7b05708a58 Updated geekdoc. hai 1 mes
static eb42615352 Upgraded hugo-geekdoc to v0.46.0 hai 5 meses
.dictionary 7b05708a58 Updated geekdoc. hai 1 mes
.gitignore 7b05708a58 Updated geekdoc. hai 1 mes
.htmlvalidate.json 7b05708a58 Updated geekdoc. hai 1 mes
.jsbeautifyrc 7b05708a58 Updated geekdoc. hai 1 mes
.lighthouserc.yml 7b05708a58 Updated geekdoc. hai 1 mes
.lycheeignore 7b05708a58 Updated geekdoc. hai 1 mes
.markdownlint.yml 7b05708a58 Updated geekdoc. hai 1 mes
.npmrc 7b05708a58 Updated geekdoc. hai 1 mes
.nvmrc 7b05708a58 Updated geekdoc. hai 1 mes
.prettierignore 7b05708a58 Updated geekdoc. hai 1 mes
.prettierrc 7b05708a58 Updated geekdoc. hai 1 mes
.tarignore 7b05708a58 Updated geekdoc. hai 1 mes
CONTRIBUTING.md 7b05708a58 Updated geekdoc. hai 1 mes
LICENSE 8710a66ab1 Changed theme to geekdoc %!s(int64=2) %!d(string=hai) anos
README.md 7b05708a58 Updated geekdoc. hai 1 mes
VERSION eb42615352 Upgraded hugo-geekdoc to v0.46.0 hai 5 meses
eslint.config.js 7b05708a58 Updated geekdoc. hai 1 mes
package-lock.json 7b05708a58 Updated geekdoc. hai 1 mes
package.json 7b05708a58 Updated geekdoc. hai 1 mes
renovate.json 7b05708a58 Updated geekdoc. hai 1 mes
svgsprite.config.json 7b05708a58 Updated geekdoc. hai 1 mes
theme.toml 7b05708a58 Updated geekdoc. hai 1 mes
webpack.config.js 7b05708a58 Updated geekdoc. hai 1 mes
webpack.plugins.js 7b05708a58 Updated geekdoc. hai 1 mes

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: