github/hugo-geekblog
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekblog.git synced 2024-11-05 21:00:50 +00:00
Code Issues Projects Releases Wiki Activity
d5f6cfb13e
hugo-geekblog/README.md
Robert Kaussow d5f6cfb13e
refator: replace gulp by webpack and npm scripts (#129) 
BREAKING CHANGE: We have replaced `gulp` with `webpack` and `npm scripts` to build this theme. If you build it on your own or use build commands during the deployment, you may have to adjust your setup.

BREAKING CHANGE: The `GeekblogIcons` font is using the icon name as Unicode now. As a consequence, you have to replace all references to Icons from this font if you have customized the theme.
2021-12-29 22:50:13 +01:00

3.1 KiB
Raw Blame History

Geekblog

Build Status Hugo Version GitHub release GitHub contributors License: MIT

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.

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 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.

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: