Go to file
2023-12-24 00:27:24 +01:00
.github ci: migrate to woodpecker (#690) 2023-08-25 12:37:28 +02:00
.gitsv fix: generate unique properties anchor (#733) 2023-10-28 22:48:31 +02:00
.woodpecker remove git fetch (#753) 2023-12-24 00:27:24 +01:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets/search chore: normalize mixed casing of code block lang and theme parameters (#647) 2023-06-22 09:45:54 +02:00
exampleSite docs: use a propertylist to document shortcode attributes (#732) 2023-10-27 21:38:23 +02:00
i18n feat: add am language support (#730) 2023-10-27 13:39:26 +02:00
images fix hugo themes library image size (#614) 2023-04-21 22:28:08 +02:00
layouts fix: generate unique properties anchor (#733) 2023-10-28 22:48:31 +02:00
src fix: generate unique properties anchor (#733) 2023-10-28 22:48:31 +02:00
.dictionary fix: remove table formatting from github gists (#416) 2022-05-24 00:37:06 +02:00
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00
.gitignore ci: improve version file and tarball creation (#486) 2022-08-29 22:53:07 +02:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml ci: run test steps in parallel 2023-08-25 23:16:59 +02:00
.lycheeignore ci: switch to lychee as linkcheck 2023-09-27 21:52:48 +02:00
.markdownlint.yml fix: fix formatting on code links (#316) 2022-02-03 11:42:26 +01:00
.npmrc chore: limit supported nodejs versions (#323) 2022-02-04 13:53:49 +01:00
.prettierignore ci: migrate to woodpecker (#690) 2023-08-25 12:37:28 +02:00
.prettierrc chore: remove unmaintained dependency prettier-plugin-go-template (#658) 2023-07-05 20:45:54 +02:00
.tarignore ci: migrate to woodpecker (#690) 2023-08-25 12:37:28 +02:00
.vnuignore fix: replace invlaid max-height value 'auto' by 'none' (#419) 2022-05-23 22:37:12 +02:00
CONTRIBUTING.md fix bare url in contribution file (#619) 2023-05-03 14:00:00 +02:00
LICENSE chore: end of the year maintenance 2021-12-21 10:37:09 +01:00
package-lock.json chore(deps): update dependency eslint to v8.56.0 2023-12-18 03:55:26 +00:00
package.json chore(deps): update dependency eslint to v8.56.0 2023-12-18 03:55:26 +00:00
README.md ci: migrate to woodpecker (#690) 2023-08-25 12:37:28 +02:00
renovate.json chore: use renovate preset config 2021-01-03 22:11:14 +01:00
svgsprite.config.json feat: add optional hint/admonition icons (#383) 2022-04-23 15:14:42 +02:00
theme.toml fix: utilize hugo.WorkingDir for a reliable edit page link (#665) 2023-07-11 21:00:27 +02:00
webpack.config.js fix: replace webpack-favicons dep by maintained favicons-webpack-plugin (#748) 2023-12-06 09:58:15 +01:00
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00

Geekdoc

Build Status Hugo Version GitHub release GitHub contributors License: MIT

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: