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 f8d2670528
migrate to thegeeklab namespace
3 days ago
.github setup prettier 2 weeks ago
archetypes initial commit 8 months ago
assets/js initial commit 8 months ago
exampleSite migrate to thegeeklab namespace 3 days ago
images adjust spacing 2 weeks ago
layouts migrate to thegeeklab namespace 3 days ago
src increase size between footer links 1 week ago
static setup prettier 2 weeks ago
.dictionary [skip ci] improve getting started documentation 2 weeks ago
.drone.yml migrate to thegeeklab namespace 3 days ago
.gitignore always try to upload lhci reports 2 months ago
.jsbeautifyrc beautify html before uploading the documentation 4 months ago
.lighthouserc.yml temp switch to warn instead of error for the performance category 1 week ago
.markdownlint.yml add unsorted list style 3 months ago
.prettierignore setup prettier 2 weeks ago
.prettierrc setup prettier 2 weeks ago
.tarignore add lighthouse-ci to drone 4 months ago
CHANGELOG.md add font and css preloading links 1 week ago
LICENSE [SKIP CI] update readme 8 months ago
README.md migrate to thegeeklab namespace 3 days ago
gulpfile.js setup prettier 2 weeks ago
package-lock.json [skip ci] improve getting started documentation 2 weeks ago
package.json migrate to thegeeklab namespace 3 days ago
theme.toml migrate to thegeeklab namespace 3 days 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
gulp default

See the Getting Started Guide for details about the different setup options.

Contributors

Special thanks goes to all contributors.

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.