Go to file
Robert Kaussow 19302de78b
fix bare url in contribution file (#385)
2023-05-03 14:00:13 +02:00
.chglog chore: adjust changelog template to link to prs instead of issues (#120) 2021-12-12 13:05:52 +01:00
.github [skip ci] adjust repo config 2022-07-21 09:56:19 +02:00
exampleSite fix bare url in contribution file (#385) 2023-05-03 14:00:13 +02:00
images fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
layouts feat: add support for custom heading css class (#381) 2023-04-21 23:05:46 +02:00
src fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
.dictionary feat: add optional hint/admonition icons (#233) 2022-04-30 14:32:07 +02:00
.drone.yml fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
.eslintrc.json refator: replace gulp by webpack and npm scripts (#129) 2021-12-29 22:50:13 +01:00
.gitignore ci: improve version file and tarball creation (#301) 2022-08-30 21:20:49 +02:00
.jsbeautifyrc add basic page layout 2020-07-06 20:55:32 +02:00
.lighthouserc.yml fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
.markdownlint.yml fix: fix formatting on feature and code links (#182) 2022-02-02 22:27:10 +01:00
.npmrc chore: limit supported nodejs versions (#188) 2022-02-05 15:02:06 +01:00
.prettierignore chore: enable auto-formatting for template files (#133) 2021-12-30 15:55:55 +01:00
.prettierrc refator: replace gulp by webpack and npm scripts (#129) 2021-12-29 22:50:13 +01:00
.tarignore refator: replace gulp by webpack and npm scripts (#129) 2021-12-29 22:50:13 +01:00
CONTRIBUTING.md fix bare url in contribution file (#385) 2023-05-03 14:00:13 +02:00
LICENSE chore: end of the year maintenance 2021-12-21 10:37:08 +01:00
README.md fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
package-lock.json chore(deps): update devdeps non-major 2023-05-01 05:56:05 +00:00
package.json chore(deps): update devdeps non-major 2023-05-01 05:56:05 +00:00
renovate.json chore: use renovate preset config 2021-01-03 22:16:30 +01:00
svgsprite.config.json feat: add option `geekblogDarkModeCode` to enforce dark code blocks (#255) 2022-06-02 14:01:56 +02:00
theme.toml feat: support mermaid codeblocks (#302) 2022-08-30 21:24:49 +02:00
webpack.config.js fix: adjust default color scheme to fix some contrast issues (#380) 2023-04-21 22:39:18 +02:00
webpack.plugins.js chore: cleanup build setup and webpack requirements (#138) 2022-01-07 16:18:11 +01:00

README.md

Geekblog

Build Status Hugo Version GitHub release GitHub contributors License: MIT

Geekblog is a simple Hugo theme for personal blogs. 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://hugo-geekblog.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.

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: