hugo hugo-theme theme blog

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

renovate[bot] be92b730ef chore(deps): update devdependencies (non-major)		3 days ago
.chglog	chore: adjust changelog template to link to prs instead of issues (#120 )	1 year ago
.github	[skip ci] adjust repo config	8 months ago
exampleSite	feat: add basic svg support to the img shortcode (#351 )	3 months ago
images	feat: add dark mode (#109 )	1 year ago
layouts	fix: issues with nested columns shortcode (#364 )	1 month ago
src	ci: temp disable linkcheck of unsplash (#369 )	3 weeks ago
.dictionary	feat: add optional hint/admonition icons (#233 )	11 months ago
.drone.yml	ci: temp disable linkcheck of unsplash (#369 )	3 weeks ago
.eslintrc.json	refator: replace gulp by webpack and npm scripts (#129 )	1 year ago
.gitignore	ci: improve version file and tarball creation (#301 )	7 months ago
.jsbeautifyrc	add basic page layout	3 years ago
.lighthouserc.yml	refator: replace gulp by webpack and npm scripts (#129 )	1 year ago
.markdownlint.yml	fix: fix formatting on feature and code links (#182 )	1 year ago
.npmrc	chore: limit supported nodejs versions (#188 )	1 year ago
.prettierignore	chore: enable auto-formatting for template files (#133 )	1 year ago
.prettierrc	refator: replace gulp by webpack and npm scripts (#129 )	1 year ago
.tarignore	refator: replace gulp by webpack and npm scripts (#129 )	1 year ago
CONTRIBUTING.md	docs: add contributing information	2 years ago
LICENSE	chore: end of the year maintenance	1 year ago
README.md	feat: support mermaid codeblocks (#302 )	7 months ago
package-lock.json	chore(deps): update devdependencies (non-major)	3 days ago
package.json	chore(deps): update devdependencies (non-major)	3 days ago
renovate.json	chore: use renovate preset config	2 years ago
svgsprite.config.json	feat: add option `geekblogDarkModeCode` to enforce dark code blocks (#255 )	10 months ago
theme.toml	feat: support mermaid codeblocks (#302 )	7 months ago
webpack.config.js	feat: add option to enable or disable the dark mode toggle button (#346 )	3 months ago
webpack.plugins.js	chore: cleanup build setup and webpack requirements (#138 )	1 year ago

README.md

Geekblog

Important: We have switched to 'main' as default branch. The 'master' branch is no longer maintained and will be removed after June 30, 2021!

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.

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:

Font Awesome: CC BY 4.0 License
IcoMoon Free Pack: GPL/CC BY 4.0
Material Icons: Apache License 2.0