burble.dn42 website
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.
 
 
 
 
Simon Marsh 3970981f1b
test pipeline
9 months ago
..
archetypes test pipeline 9 months ago
assets test pipeline 9 months ago
data test pipeline 9 months ago
images test pipeline 9 months ago
layouts test pipeline 9 months ago
static test pipeline 9 months ago
.jsbeautifyrc test pipeline 9 months ago
.prettierignore test pipeline 9 months ago
.prettierrc test pipeline 9 months ago
CHANGELOG.md test pipeline 9 months ago
LICENSE test pipeline 9 months ago
README.md test pipeline 9 months ago
VERSION test pipeline 9 months ago
theme.toml test pipeline 9 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
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.

The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack: