Go to file
2021-05-25 17:56:53 +02:00
.chglog ci: auto-generate changelog 2021-02-11 21:25:43 +01:00
.github [skip ci] fix github settings syntax 2021-05-25 17:56:53 +02:00
archetypes initial commit 2020-01-12 15:33:02 +01:00
assets feat: add page parameter geekdocNav to disable navigation sidebar (#129) 2021-05-18 23:10:42 +02:00
data hash css/js assets by default 2020-11-22 19:06:04 +01:00
exampleSite add missing button sizes documentation 2021-05-24 15:12:58 +02:00
images chore: scale down the readme image to improve readability 2021-04-28 09:31:23 +02:00
layouts feat: add sizes 'regular' and 'large' to button shortcode (#135) 2021-05-21 15:51:19 +02:00
src remove old icon telescope from iconfont as well 2021-05-23 17:37:56 +02:00
static remove old font files 2021-05-24 14:11:23 +02:00
.dictionary feat: add page parameter geekdocNav to disable navigation sidebar (#129) 2021-05-18 23:10:42 +02:00
.drone.yml fix ci 2021-05-23 18:30:02 +02:00
.gitignore refactor: cleanup and restructure gulp tasks (#101) 2021-05-05 22:44:36 +02:00
.jsbeautifyrc beautify html before uploading the documentation 2020-06-02 19:43:52 +02:00
.lighthouserc.yml chore: set a proper value for lighthouse throttling (#59) 2021-02-07 14:13:39 +01:00
.markdownlint.yml add unsorted list style 2020-06-03 16:47:10 +02:00
.npmrc refactor: cleanup and restructure gulp tasks (#101) 2021-05-05 22:44:36 +02:00
.prettierignore setup prettier 2020-09-10 22:23:24 +02:00
.prettierrc setup prettier 2020-09-10 22:23:24 +02:00
.tarignore chore: cleanup release tarballs 2021-05-23 18:47:24 +02:00
CONTRIBUTING.md docs: add contributing information 2021-01-03 22:10:01 +01:00
gulpfile.js docs: autogenerate sprites data file during build (#136) 2021-05-23 18:19:46 +02:00
LICENSE update to hugo v0.80 in ci 2021-01-03 22:13:59 +01:00
package-lock.json chore(deps): lock file maintenance (#137) 2021-05-24 13:19:40 +02:00
package.json fix(deps): update dependency mermaid to v8.10.1 (#115) 2021-05-10 22:08:49 +02:00
README.md chore: fix capitalization for params in while clause (#108) 2021-05-06 21:42:45 +02:00
renovate.json chore: use renovate preset config 2021-01-03 22:11:14 +01:00
theme.toml chore: fix capitalization for params in while clause (#108) 2021-05-06 21:42:45 +02: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 got 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 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: