Hugo-Theme für hilfe.systemausfall.org basierend auf Geekdocs
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
phil a3bcd89c70 Small color changes 2 months ago
.github [skip ci] adjust repo config 8 months ago
archetypes initial commit 3 years ago
assets/search feat: add optional page description to search (#550) 4 months ago
i18n fix: add missing navigation for pagination (#540) 4 months ago
images chore: scale down the readme image to improve readability 2 years ago
layouts Support svg 2 months ago
src Small color changes 2 months ago
.dictionary fix: remove table formatting from github gists (#416) 10 months ago
.drone.yml chore: bump hugo to v0.105.0 (#532) 5 months ago
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.gitignore ci: improve version file and tarball creation (#486) 7 months ago
.jsbeautifyrc beautify html before uploading the documentation 3 years ago
.lighthouserc.yml ci: relax image-size-responsive in lighthouse runs (#328) 1 year ago
.markdownlint.yml fix: fix formatting on code links (#316) 1 year ago
.npmrc chore: limit supported nodejs versions (#323) 1 year ago
.prettierignore refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.prettierrc refactor: replace gulp by webpack and npm scripts (#258) 1 year ago
.tarignore chore: remove .vnuignore from release tarball (#264) 1 year ago
.vnuignore fix: replace invlaid max-height value 'auto' by 'none' (#419) 10 months ago
CONTRIBUTING.md docs: add contributing information 2 years ago
LICENSE chore: end of the year maintenance 1 year ago
README.md ci: improve version file and tarball creation (#486) 7 months ago
package-lock.json Update dependencies 2 months ago
package.json Update dependencies 2 months ago
renovate.json chore: use renovate preset config 2 years ago
svgsprite.config.json feat: add optional hint/admonition icons (#383) 11 months ago
theme.toml feat: support mermaid codeblocks (#485) 7 months ago
webpack.config.js feat: add option to enable or disable the dark mode toggle button (#529) 5 months ago
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 1 year 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 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: