hugo-geekblog/README.md

45 lines
3.0 KiB
Markdown
Raw Normal View History

2020-09-12 16:04:41 +00:00
# Geekblog
2020-06-27 21:07:52 +00:00
2021-02-22 09:13:37 +00:00
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekblog?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekblog)
2020-06-27 21:07:52 +00:00
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
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/main/LICENSE)
2020-06-27 21:07:52 +00:00
> **Important:** We have switched to 'main' as default branch. The 'master' branch is no longer maintained and will be removed after June 30, 2021!
2021-05-24 12:02:31 +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 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](https://hugo-geekblog.geekdocs.de).
2020-06-27 21:07:52 +00:00
![Desktop and mobile preview](https://github.com/thegeeklab/hugo-geekblog/blob/main/images/readme.png)
2020-09-12 16:53:25 +00:00
2020-09-12 16:04:41 +00:00
## Build and release process
2020-08-01 18:18:20 +00:00
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).
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 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 `gulp` locally and run the default pipeline once to create all required assets.
2020-09-12 16:04:41 +00:00
```Shell
# install required packages from package.json
npm install
# run gulp pipeline to build required assets
2021-01-06 17:31:00 +00:00
npx gulp default
2020-09-12 16:04:41 +00:00
```
2020-06-27 21:07:52 +00:00
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.
2020-06-27 21:07:52 +00:00
2020-09-12 16:04:41 +00:00
## Contributors
2021-01-03 21:16:15 +00:00
Special thanks goes to all [contributors](https://github.com/thegeeklab/hugo-geekblog/graphs/contributors). If you would like to contribute,
please see the [instructions](https://github.com/thegeeklab/hugo-geekblog/blob/main/CONTRIBUTING.md).
2020-09-12 16:04:41 +00:00
## License
2020-06-27 21:07:52 +00:00
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekblog/blob/main/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/main/LICENSE)