Skip to content

Commit 80a9fbe

Browse files
committed
doc: Add screenshots, badges to README
1 parent 197c380 commit 80a9fbe

File tree

6 files changed

+51
-2
lines changed

6 files changed

+51
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,29 @@ Hugo theme designed for reading and printing text with dark and light modes.
55

66
Demo example site [manid2.github.io/hugo-xterm][7].
77

8+
[![Hugo][hugo_ver_img]][hugo_v0110]
9+
[![LICENSE][hx_lic_img]][hx_lic_link]
10+
[![Build][hx_ci_build_img]][hx_ci_build_link]
11+
12+
Screenshots
13+
-----------
14+
15+
Dark mode:
16+
17+
![Hugo Xterm Dark][hx_ss_dark]
18+
19+
Light mode:
20+
21+
![Hugo Xterm Light][hx_ss_light]
22+
23+
CV template:
24+
25+
![Hugo Xterm CV][hx_ss_cv]
26+
27+
Features:
28+
29+
![Hugo Xterm features][hx_ss_feat]
30+
831
Features
932
--------
1033

@@ -84,7 +107,7 @@ features from popular themes and websites as listed below:
84107
License
85108
-------
86109

87-
[GNU General Public License v3.0][11]
110+
[GNU General Public License v3.0][hx_lic_link]
88111

89112
[1]: https://github.com/panr/hugo-theme-terminal
90113
[2]: https://github.com/adityatelange/hugo-PaperMod
@@ -96,4 +119,17 @@ License
96119
[8]: https://en.wikipedia.org/wiki/HSL_and_HSV
97120
[9]: https://github.com/alecthomas/chroma/
98121
[10]: https://manid2.gitlab.io/cv/
99-
[11]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE
122+
123+
[hx_ci_build_img]: https://img.shields.io/github/actions/workflow/status/manid2/hugo-xterm/hugo.yaml?logo=github "Hugo Xterm build status badge"
124+
[hx_ci_build_link]: https://github.com/manid2/hugo-xterm/actions
125+
126+
[hx_lic_img]: https://img.shields.io/github/license/manid2/hugo-xterm?logo=gnu&logoColor=black&label=License&labelColor=lightcyan "Hugo Xterm license badge"
127+
[hx_lic_link]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE
128+
129+
[hugo_ver_img]: https://img.shields.io/badge/Hugo%20Extended-%3E%3D%20v0.110.0-blue.svg?style=flat&logo=hugo&logoColor=white&label=Hugo%20Extended&labelColor=grey "Hugo Extended >= v0.110.0"
130+
[hugo_v0110]: https://github.com/gohugoio/hugo/releases/tag/v0.110.0
131+
132+
[hx_ss_dark]: static/screenshots/hugo-xterm-ss-01-dark.png "Hugo Xterm dark mode screenshot"
133+
[hx_ss_light]: static/screenshots/hugo-xterm-ss-02-light.png "Hugo Xterm light mode screenshot"
134+
[hx_ss_cv]: static/screenshots/hugo-xterm-ss-03-cv.png "Hugo Xterm CV template screenshot"
135+
[hx_ss_feat]: static/screenshots/hugo-xterm-ss-04-features.png "Hugo Xterm features screenshot"

exampleSite/content/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,17 @@ toc = false
88

99
This is the demo example site for [manid2/hugo-xterm][1] theme.
1010

11+
[![Hugo][hugo_ver_img]][hugo_v0110]
12+
[![LICENSE][hx_lic_img]][hx_lic_link]
13+
[![Build][hx_ci_build_img]][hx_ci_build_link]
14+
1115
[1]: https://github.com/manid2/hugo-xterm
16+
17+
[hx_ci_build_img]: https://img.shields.io/github/actions/workflow/status/manid2/hugo-xterm/hugo.yaml?logo=github "Hugo Xterm build status badge"
18+
[hx_ci_build_link]: https://github.com/manid2/hugo-xterm/actions
19+
20+
[hx_lic_img]: https://img.shields.io/github/license/manid2/hugo-xterm?logo=gnu&logoColor=black&label=License&labelColor=lightcyan "Hugo Xterm license badge"
21+
[hx_lic_link]: https://github.com/manid2/hugo-xterm/blob/main/LICENSE
22+
23+
[hugo_ver_img]: https://img.shields.io/badge/Hugo%20Extended-%3E%3D%20v0.110.0-blue.svg?style=flat&logo=hugo&logoColor=white&label=Hugo%20Extended&labelColor=grey "Hugo Extended >= v0.110.0"
24+
[hugo_v0110]: https://github.com/gohugoio/hugo/releases/tag/v0.110.0
115 KB
Loading
116 KB
Loading
223 KB
Loading
157 KB
Loading

0 commit comments

Comments
 (0)