5c5e2d59cb
BREAKING CHANGE: We have replaced `gulp` with `webpack` and `npm scripts` to build this theme. If you build it on your own or use build commands during the deployment, you may have to adjust your setup. BREAKING CHANGE: The `GeekblogIcons` font is using the icon name as Unicode now. As a consequence, you have to replace all references to Icons from this font if you have customized the theme. BREAKING CHANGE: We have refactored the search integration to split Hugo templates from JavaScript code. To get it working again, you need to adjust the `outputFormats` and `outputs` in your Hugo configuration file, as [documented](https://geekdocs.de/usage/configuration/#site-configuration). |
||
|---|---|---|
| .chglog | ||
| .github | ||
| archetypes | ||
| assets/search | ||
| exampleSite | ||
| images | ||
| layouts | ||
| src | ||
| .dictionary | ||
| .drone.yml | ||
| .eslintrc.json | ||
| .gitignore | ||
| .jsbeautifyrc | ||
| .lighthouserc.yml | ||
| .markdownlint.yml | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| .tarignore | ||
| .vnuignore | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| package-lock.json | ||
| package.json | ||
| renovate.json | ||
| svgsprite.config.json | ||
| theme.toml | ||
| webpack.config.js | ||
| webpack.plugins.js | ||
README.md
Geekdoc
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 gulp and bundled in a release tarball. You can download the latest release from the GitHub release page.
Due to the fact that gulp is used as pre-processor 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 gulp locally and run the default pipeline once to create all required assets.
# install required packages from package.json
npm install
# run gulp pipeline to build required assets
npx gulp default
See the Getting Started Guide for details about the different setup options.
Contributors
Special thanks goes 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