@@ -3,6 +3,15 @@ hugo-xterm
3
3
4
4
Hugo theme designed for reading and printing text with dark and light modes.
5
5
6
+ It uses Hugo extended version with __ >= 0.110__ to build the theme to take
7
+ advantage of builtin SCSS compiler and reduce dependency on external
8
+ libraries.
9
+
10
+ This theme is fully free and open source so it can be used and modified as you
11
+ like but redistributing requires attribution to [ license] [ hx_lic_link ] and
12
+ credits to author [ Mani Kumar] [ md2_gh_link ] with link to this repository
13
+ [ hugo-xterm] [ hx_gh_link ] .
14
+
6
15
[ ![ Hugo] [ hugo_ver_img ]] [ hugo_v0110 ]
7
16
[ ![ LICENSE] [ hx_lic_img ]] [ hx_lic_link ]
8
17
[ ![ Build] [ hx_ci_build_img ]] [ hx_ci_build_link ]
@@ -14,14 +23,6 @@ Demo example site [manid2.github.io/hugo-xterm][7].
14
23
15
24
[ ![ Hugo Xterm demo site QR code] [ hx_demo_qr_img ]] [ 7 ]
16
25
17
- Support
18
- -------
19
-
20
- Kindly support this theme development by donating at [ Buy me a
21
- coffee] [ md2_bmc_link ] .
22
-
23
- [ ![ Mani Kumar Buy Me a Coffee QR code] [ md2_bmc_qr_img ]] [ md2_bmc_link ]
24
-
25
26
Screenshots
26
27
-----------
27
28
@@ -180,6 +181,35 @@ ctags -R assets/ layouts/ config.toml theme.toml
180
181
ctags -R exampleSite/layouts/ exampleSite/scripts/ exampleSite/config
181
182
```
182
183
184
+ Request feature & report bugs
185
+ -----------------------------
186
+
187
+ If you find any bugs or need any features then please raise an
188
+ [ issue] [ hx_gh_issues_link ] so that it can tracked and avoid same requests from
189
+ other users.
190
+
191
+ You can also fix the bug or implement the feature yourself and raise a [ pull
192
+ request] [ hx_gh_pr_link ] so I can review and integrate it into this theme with
193
+ credits to you as a contributor.
194
+
195
+ Use the theme & want to show your site?
196
+ ---------------------------------------
197
+
198
+ I would be happy to know that you use this theme and want to show your site.
199
+ For this please raise a pull request with link to your site, your
200
+ name/username, profession/study mentioned in this list [ hugo-xterm
201
+ users] [ hx_users_link ] .
202
+
203
+ Support
204
+ -------
205
+
206
+ Kindly support this theme development by donating at [ Buy me a
207
+ coffee] [ md2_bmc_link ] .
208
+
209
+ TODO Add current supporters.
210
+
211
+ [ ![ Mani Kumar Buy Me a Coffee QR code] [ md2_bmc_qr_img ]] [ md2_bmc_link ]
212
+
183
213
Credits
184
214
-------
185
215
@@ -223,6 +253,11 @@ License
223
253
[ hx_ss_slides ] : https://manid2.github.io/hugo-xterm/screenshots/hugo-xterm-ss-04-slides.png " Hugo Xterm slides screenshot "
224
254
225
255
[ hx_demo_qr_img ] : https://quickchart.io/qr?text=https%3A%2F%2Fmanid2.github.io%2Fhugo-xterm%2F&dark=1a5fb4&size=200
256
+ [ hx_gh_link ] : https://github.com/manid2/hugo-xterm
257
+ [ hx_gh_issues_link ] : https://github.com/manid2/hugo-xterm/issues
258
+ [ hx_gh_pr_link ] : https://github.com/manid2/hugo-xterm/pulls
259
+ [ hx_users_link ] : https://github.com/manid2/hugo-xterm/blob/main/USERS.md
226
260
227
261
[ md2_bmc_link ] : https://www.buymeacoffee.com/manid2
228
262
[ md2_bmc_qr_img ] : https://manid2.gitlab.io/images/md2_bmc_qr.png
263
+ [ md2_gh_link ] : https://github.com/manid2
0 commit comments