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
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.
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: