You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Robert Kaussow 5c15ade342
fix: enforce css overwrite for raw links (#77)
4 days ago
.chglog ci: auto-generate changelog 2 weeks ago
.github setup prettier 5 months ago
archetypes initial commit 1 year ago
assets fix: fetch search data as JSON rather than JS (#43) 1 month ago
data hash css/js assets by default 3 months ago
exampleSite docs: add pluralizeListTitles = false to min config example 6 days ago
images adjust spacing 5 months ago
layouts fix: ensure render template contains no empty newlines (#76) 4 days ago
src fix: enforce css overwrite for raw links (#77) 4 days ago
static hash css/js assets by default 3 months ago
.dictionary fix spellchecking 2 months ago
.drone.yml fix wording 1 week ago
.gitignore ci: auto-generate changelog 2 weeks ago
.jsbeautifyrc beautify html before uploading the documentation 9 months ago
.lighthouserc.yml chore: set a proper value for lighthouse throttling (#59) 3 weeks ago
.markdownlint.yml add unsorted list style 9 months ago
.prettierignore setup prettier 5 months ago
.prettierrc setup prettier 5 months ago
.tarignore add documentation for different menu type 2 months ago
CONTRIBUTING.md docs: add contributing information 1 month ago
LICENSE update to hugo v0.80 in ci 1 month ago
README.md docs: fix ci badge 6 days ago
gulpfile.js normalize source icon size for the icon font 3 months ago
package-lock.json chore(deps): update dependency gulp-iconfont to v11 (#48) 1 month ago
package.json chore(deps): update dependency gulp-iconfont to v11 (#48) 1 month ago
renovate.json chore: use renovate preset config 1 month ago
theme.toml migrate to thegeeklab namespace 5 months ago

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 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 master 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: