diff --git a/README.md b/README.md index dc96221..ffc8070 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# Hugo Geekdoc Theme +# Geekdoc [![Build Status](https://img.shields.io/drone/build/xoxys/hugo-geekdoc?logo=drone)](https://cloud.drone.io/xoxys/hugo-geekdoc) [![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io) [![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest) +[![GitHub contributors](https://img.shields.io/github/contributors/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors) [![License: MIT](https://img.shields.io/github/license/xoxys/hugo-geekdoc)](LICENSE) -Geekdoc is a simple Hugo theme for documentations. This work is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de). +Geekdoc is a simple Hugo theme for documentations. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de). -![Screenshot](https://github.com/xoxys/hugo-geekdoc/blob/master/images/screenshot.png) +![Preview Desktop](https://github.com/xoxys/hugo-geekdoc/blob/master/images/rm-desktop.png) ![Preview Mobile](https://github.com/xoxys/hugo-geekdoc/blob/master/images/rm-mobile.png) + +## Contributors + +Special thanks goes to all [contributors](https://github.com/xoxys/hugo-geekdoc/graphs/contributors). + +Geekdoc is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme, thanks [Alex Shpak](https://github.com/alex-shpak/) for your work. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. - -## Maintainers and Contributors - -[Robert Kaussow](https://github.com/xoxys) diff --git a/images/rm-desktop.png b/images/rm-desktop.png new file mode 100644 index 0000000..bc6395d Binary files /dev/null and b/images/rm-desktop.png differ diff --git a/images/rm-mobile.png b/images/rm-mobile.png new file mode 100644 index 0000000..1871b60 Binary files /dev/null and b/images/rm-mobile.png differ diff --git a/images/screenshot-plain.png b/images/screenshot-plain.png new file mode 100644 index 0000000..2fb085f Binary files /dev/null and b/images/screenshot-plain.png differ diff --git a/images/screenshot.png b/images/screenshot.png index 2fb085f..f2b625f 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ