Skip to content

Commit a54c587

Browse files
manid2manid2
committed
feat: [doc] Update feature list and credits
1 parent 8bc13c0 commit a54c587

File tree

4 files changed

+132
-7
lines changed

4 files changed

+132
-7
lines changed

‎README.md

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,47 @@
11
hugo-xterm
22
==========
33

4-
A simple Hugo theme for terminal users.
4+
Hugo theme designed for reading and printing text with dark and light modes.
55

6-
This was initially based on [panr/terminal][1] theme but has deviated
7-
significantly and deserves to be a new theme.
6+
Demo example site [manid2.github.io/hugo-xterm][7].
7+
8+
Features
9+
--------
10+
11+
* Designed for reading and printing text.
12+
* Switchable dark and light themes with automatic selection based on system
13+
theme.
14+
* Uses blue for text, accent and background, green for links.
15+
* Code blocks are highlighted using Hugo built-in blazing fast Chroma.
16+
* Copy code, see code language and file name (optional).
17+
* Slides support using [reveal.js][4] (improvement is WIP).
18+
* Pint any page in light theme mode.
19+
* Support for CV or resume (dedicated layout is WIP).
20+
* Separate view and pagination for list items and post entries.
21+
* Theme can be customized using configurations for: full width, centered.
22+
* SEO friendly OpenGraph and twitter cards support
23+
* Minimal configuration.
24+
* Taxonomies and posts RSS.
25+
* Show git information for site and per single page.
26+
* Tightly coupled with Hugo extended latest version (v1.110.0) to compile and
27+
generate asset bundles with pipelines, fingerprinting and minification.
28+
* Responsive tested on desktop and on smart phones of 684px.
29+
* Responsive menus for desktop and mobile screens.
30+
* Accessible tested using [WAVE Web Accessibility Evaluation Tool][5].
31+
32+
Other features are supported but not tested yet:
33+
34+
* Post cover image.
35+
* Images in post with caption.
36+
* Comments.
37+
* Website banner.
38+
39+
Installation
40+
------------
41+
42+
Follows the same steps for installing and updating a Hugo theme such as this
43+
link for installing and updating PaperMode theme
44+
[adityatelange/hugo-PaperMod/wiki/Installation][6].
845

946
Local development
1047
-----------------
@@ -15,4 +52,23 @@ Local development
1552
hugo server --source exampleSite
1653
```
1754

55+
Credits
56+
-------
57+
58+
This theme was initially based on [panr/terminal][1] theme but is re-written
59+
from scratch to optimize for reading and print text heavy web pages.
60+
61+
Parts of the features in this theme are either taken directly or based on the
62+
features from popular themes and websites as listed below:
63+
64+
* [panr/terminal][1]: most styles, menus and starter code.
65+
* [adityatelange/hugo-PaperMod][2] features: breadcrumbs and copy code.
66+
* [kaitlinmctigue/kaitlinmctigue.github.io][3]: dark and light theme modes.
67+
1868
[1]: https://github.com/panr/hugo-theme-terminal
69+
[2]: https://github.com/adityatelange/hugo-PaperMod
70+
[3]: https://github.com/kaitlinmctigue/kaitlinmctigue.github.io
71+
[4]: https://github.com/hakimel/reveal.js
72+
[5]: https://wave.webaim.org/
73+
[6]: https://github.com/adityatelange/hugo-PaperMod/wiki/Installation
74+
[7]: https://manid2.github.io/hugo-xterm/

‎exampleSite/content/_index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
+++
22
title = "Hugo Xterm"
3-
description = """Hugo theme for terminal users."""
3+
description = """Hugo theme designed for reading and printing text with dark \
4+
and light modes."""
45
date = "2023-07-15"
56
toc = false
67
+++
8+
9+
This is the demo example site for [manid2/hugo-xterm][1] theme.
10+
11+
[1]: https://github.com/manid2/hugo-xterm

‎exampleSite/content/about.md

Lines changed: 64 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,70 @@ description = "About hugo-xterm theme."
44
toc = false
55
+++
66

7-
A simple Hugo theme for terminal users.
7+
Hugo theme designed for reading and printing text with dark and light modes.
88

9-
This was initially based on [panr/terminal][1] theme but has deviated
10-
significantly and deserves to be a new theme.
9+
Features
10+
--------
11+
12+
* Designed for reading and printing text.
13+
* Switchable dark and light themes, automatic selection based on system theme.
14+
* Uses blue for text, accent and background, green for links.
15+
* Code blocks are highlighted using Hugo built-in blazing fast Chroma.
16+
* Copy code, see code language and file name (optional).
17+
* Slides support using [reveal.js][4] (improvement is WIP).
18+
* Pint any page in light theme mode.
19+
* Support for CV or resume (dedicated layout is WIP).
20+
* Separate view and pagination for list items and post entries.
21+
* Theme can be customized using configurations for: full width, centered.
22+
* SEO friendly OpenGraph and twitter cards support
23+
* Minimal configuration.
24+
* Taxonomies and posts RSS.
25+
* Show git information for site and per single page.
26+
* Tightly coupled with Hugo extended latest version (v1.110.0) to compile and
27+
generate asset bundles with pipelines, fingerprinting and minification.
28+
* Responsive tested on desktop and on smart phones of 684px.
29+
* Responsive menus for desktop and mobile screens.
30+
* Accessible tested using [WAVE Web Accessibility Evaluation Tool][5].
31+
32+
Other features are supported but not tested yet:
33+
34+
* Post cover image.
35+
* Images in post with caption.
36+
* Comments.
37+
* Website banner.
38+
39+
Installation
40+
------------
41+
42+
Follows the same steps for installing and updating a Hugo theme such as this
43+
link for installing and updating PaperMode theme
44+
[adityatelange/hugo-PaperMod/wiki/Installation][6].
45+
46+
Local development
47+
-----------------
48+
49+
```bash
50+
# add to go.mod for local development
51+
# replace github.com/manid2/hugo-xterm => ../hugo-xterm
52+
hugo server --source exampleSite
53+
```
54+
55+
Credits
56+
-------
57+
58+
This theme was initially based on [panr/terminal][1] theme but is re-written
59+
from scratch to optimize for reading and print text heavy web pages.
60+
61+
Parts of the features in this theme are either taken directly or based on the
62+
features from popular themes and websites as listed below:
63+
64+
* [panr/terminal][1]: most styles, menus and starter code.
65+
* [adityatelange/hugo-PaperMod][2] features: breadcrumbs and copy code.
66+
* [kaitlinmctigue/kaitlinmctigue.github.io][3]: dark and light theme modes.
1167

1268
[1]: https://github.com/panr/hugo-theme-terminal
69+
[2]: https://github.com/adityatelange/hugo-PaperMod
70+
[3]: https://github.com/kaitlinmctigue/kaitlinmctigue.github.io
71+
[4]: https://github.com/hakimel/reveal.js
72+
[5]: https://wave.webaim.org/
73+
[6]: https://github.com/adityatelange/hugo-PaperMod/wiki/Installation

‎exampleSite/content/docs/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ author = "Mani Kumar"
77
[cascade]
88
list_type = "docs_list"
99
+++
10+
11+
This page shows the list of items which are not articles and don't need a
12+
date, author and other meta data associated. They are like simple documents.

0 commit comments

Comments
 (0)