c9f809ca19
BREAKING CHANGE: With support of the multilingual mode, we broke the `edit page` links, as the content directory was statically hard-coded into the `GeekdocEditPath` parameter. To get the correct content directory, regardless of the language or a disabled multilingual mode, we now use Hugo's built-in `.Site.Params.contentDir` parameter. Therefor, you have to remove the hard-coded `/content` part from the `geekdocEditPath` parameter in the configuration of your project. |
||
|---|---|---|
| .chglog | ||
| .github | ||
| archetypes | ||
| assets/search | ||
| exampleSite | ||
| i18n | ||
| 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 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
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