mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-11-21 20:30:39 +00:00
improve readme and screenshots
This commit is contained in:
parent
a81f858848
commit
de17aec404
17
README.md
17
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)
|
[![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)
|
[![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 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)
|
[![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
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
||||||
## Maintainers and Contributors
|
|
||||||
|
|
||||||
[Robert Kaussow](https://github.com/xoxys)
|
|
||||||
|
BIN
images/rm-desktop.png
Normal file
BIN
images/rm-desktop.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 194 KiB |
BIN
images/rm-mobile.png
Normal file
BIN
images/rm-mobile.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 63 KiB |
BIN
images/screenshot-plain.png
Normal file
BIN
images/screenshot-plain.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 232 KiB |
Binary file not shown.
Before Width: | Height: | Size: 232 KiB After Width: | Height: | Size: 233 KiB |
Loading…
Reference in New Issue
Block a user