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 3c37dad0ce
test render string
5 months ago
.chglog chore: adjust changelog template to link to prs instead of issues (#252) 12 months ago
.github [skip ci] fix github settings syntax 2 years ago
archetypes initial commit 3 years ago
assets/search refactor: unify title and description handling in meta files (#329) 10 months ago
exampleSite test render string 5 months ago
i18n feat: add propertylist shortcode (#414) 6 months ago
images chore: scale down the readme image to improve readability 2 years ago
layouts fix button class handling (#444) 5 months ago
src fix: fix execption while creating the code copy button (#439) 6 months ago
.dictionary fix: remove table formatting from github gists (#416) 6 months ago
.drone.yml ci: switch to linkchecker (#410) 7 months ago
.eslintrc.json refactor: replace gulp by webpack and npm scripts (#258) 11 months ago
.gitignore fix: fix edit page link and auto-detect contentDir (#343) 10 months ago
.jsbeautifyrc beautify html before uploading the documentation 3 years ago
.lighthouserc.yml ci: relax image-size-responsive in lighthouse runs (#328) 10 months ago
.linkcheckignore ci: switch to linkchecker (#410) 7 months ago
.markdownlint.yml fix: fix formatting on code links (#316) 10 months ago
.npmrc chore: limit supported nodejs versions (#323) 10 months ago
.prettierignore refactor: replace gulp by webpack and npm scripts (#258) 11 months ago
.prettierrc refactor: replace gulp by webpack and npm scripts (#258) 11 months ago
.tarignore chore: remove .vnuignore from release tarball (#264) 11 months ago
.vnuignore fix: replace invlaid max-height value 'auto' by 'none' (#419) 6 months ago
CONTRIBUTING.md docs: add contributing information 2 years ago
LICENSE chore: end of the year maintenance 11 months ago
README.md docs: fix theme build documentation (#318) 10 months ago
package-lock.json chore(deps): lock file maintenance (#447) 5 months ago
package.json chore(deps): update devdependencies (non-major) 5 months ago
renovate.json chore: use renovate preset config 2 years ago
svgsprite.config.json feat: add optional hint/admonition icons (#383) 7 months ago
theme.toml add demosite config for hugoThemesSiteBuilder (#161) 1 year ago
webpack.config.js fix: improve keyboard accessability for anchors and code blocks (#434) 6 months ago
webpack.plugins.js refactor: replace gulp by webpack and npm scripts (#258) 11 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 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

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: