hugo-geekblog/README.md

# Geekblog

[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone)](https://cloud.drone.io/thegeeklab/hugo-geekblog)
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/master/LICENSE)

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 websites. 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](https://hugo-geekblog.geekdocs.de).

![Desktop and mobile preview](https://github.com/thegeeklab/hugo-geekblog/blob/master/images/readme.png)

## 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 [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekblog/releases).

Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the master branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets.

```Shell
# install required packages from package.json
npm install

# run gulp pipeline to build required assets
gulp default
```

See the [Getting Started Guide](https://hugo-geekblog.geekdocs.de/posts/getting-started/) for details about the different setup options.

## Contributors

Special thanks goes to all [contributors](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors).

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekblog/blob/master/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](https://github.com/FortAwesome/Font-Awesome#license)
- IcoMoon Free Pack: [GPL/CC BY 4.0](https://icomoon.io/#icons-icomoon)
- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)
add getting started guide 2020-09-12 16:04:41 +00:00			`# Geekblog`
initial commit 2020-06-27 21:07:52 +00:00
migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone)](https://cloud.drone.io/thegeeklab/hugo-geekblog)`
initial commit 2020-06-27 21:07:52 +00:00			`[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)`
migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/releases/latest)`
			`[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors)`
			`[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekblog)](https://github.com/thegeeklab/hugo-geekblog/blob/master/LICENSE)`
initial commit 2020-06-27 21:07:52 +00:00
fix wording 2020-09-12 16:57:43 +00:00			`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 websites. 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](https://hugo-geekblog.geekdocs.de).`
initial commit 2020-06-27 21:07:52 +00:00
migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`![Desktop and mobile preview](https://github.com/thegeeklab/hugo-geekblog/blob/master/images/readme.png)`
replace screenshots 2020-09-12 16:53:25 +00:00
add getting started guide 2020-09-12 16:04:41 +00:00			`## Build and release process`
add screenshot 2020-08-01 18:18:20 +00:00
migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`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 [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekblog/releases).`
add getting started guide 2020-09-12 16:04:41 +00:00
			Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the master branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets.

			```Shell
			`# install required packages from package.json`
			`npm install`

			`# run gulp pipeline to build required assets`
			`gulp default`
			```
initial commit 2020-06-27 21:07:52 +00:00
add getting started guide 2020-09-12 16:04:41 +00:00			`See the [Getting Started Guide](https://hugo-geekblog.geekdocs.de/posts/getting-started/) for details about the different setup options.`
initial commit 2020-06-27 21:07:52 +00:00
add getting started guide 2020-09-12 16:04:41 +00:00			`## Contributors`

migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`Special thanks goes to all [contributors](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors).`
add getting started guide 2020-09-12 16:04:41 +00:00
			`## License`
initial commit 2020-06-27 21:07:52 +00:00
migrate to thegeeklab namespace 2020-09-27 20:14:36 +00:00			`This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekblog/blob/master/LICENSE) file for details.`
add license information for used icon packs 2020-11-26 21:29:26 +00:00
			`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](https://github.com/FortAwesome/Font-Awesome#license)`
			`- IcoMoon Free Pack: [GPL/CC BY 4.0](https://icomoon.io/#icons-icomoon)`
			`- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)`