Go to file
renovate[bot] 6d36b282fb
chore(deps): update dependency eslint to v9
2024-05-27 05:18:27 +00: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 chore(deps): update quay.io/thegeeklab/hugo docker tag to v0.125.7 (#832) 2024-05-14 15:09:11 +02: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 refactor: move profile size from img to degicated avatar shortcode (#817) 2024-04-07 21:54:12 +02:00
i18n feat: add fr language support (#822) 2024-04-17 08:55:36 +02:00
images fix hugo themes library image size (#614) 2023-04-21 22:28:08 +02:00
layouts refactor: move profile size from img to degicated avatar shortcode (#817) 2024-04-07 21:54:12 +02:00
src chore: rework js imports (#766) 2024-01-09 14:29:53 +01:00
.dictionary fix: remove table formatting from github gists (#416) 2022-05-24 00:37:06 +02:00
.eslintrc.json chore: rework js imports (#766) 2024-01-09 14:29:53 +01:00
.gitignore ci: improve version file and tarball creation (#486) 2022-08-29 22:53:07 +02:00
.htmlvalidate.json ci: replace vnu html validator by html-validate (#759) 2024-01-07 14:46:07 +01:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml chore(deps): update quay.io/thegeeklab/lhci docker tag to v0.13 (#760) 2024-01-08 08:32:21 +01:00
.lycheeignore ci: switch to lychee as linkcheck 2023-09-27 21:52:48 +02:00
.markdownlint.yml docs: fix format of the netlify makefile example (#785) 2024-02-11 13:10:35 +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 cleanup packages and tarignore 2024-01-15 20:55:41 +01: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
README.md ci: migrate to woodpecker (#690) 2023-08-25 12:37:28 +02:00
package-lock.json chore(deps): update dependency eslint to v9 2024-05-27 05:18:27 +00:00
package.json chore(deps): update dependency eslint to v9 2024-05-27 05:18:27 +00: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 chore: rework js imports (#766) 2024-01-09 14:29:53 +01:00
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 2022-01-06 13:58:10 +01:00

README.md

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: