@@ -69,7 +69,7 @@ Features
69
69
* Switchable dark and light themes with automatic selection based on system
70
70
theme.
71
71
* SEO friendly OpenGraph and twitter cards support
72
- * Customizable using configurations for: "full width: , "centered".
72
+ * Customizable using configurations for: "full width" , "centered".
73
73
* Taxonomies and posts RSS.
74
74
* Responsive tested on desktop and on smart phones.
75
75
* Responsive menus for desktop and mobile screens.
@@ -91,9 +91,79 @@ tested as I don't use them myself:
91
91
Installation
92
92
------------
93
93
94
- Follows the same steps for installing and updating a Hugo theme such as this
95
- link for installing and updating PaperMode theme
96
- [ adityatelange/hugo-PaperMod/wiki/Installation] [ 6 ] .
94
+ Follow the steps in any one of these methods to install or update a Hugo
95
+ theme.
96
+
97
+ ### Method - Using hugo mod
98
+
99
+ Add hugo-xterm theme as Hugo module to hide the theme content and let you
100
+ focus only on your site content. Let Hugo handle the theme updates
101
+ automatically and control the theme as a Hugo module instead of git.
102
+
103
+ ``` bash
104
+ cd < your-site-directory>
105
+
106
+ # initialize your site as a hugo module.
107
+ hugo mod init < your-repo-host/your-username/your-site-repo>
108
+
109
+ # import hugo-xterm theme as hugo module in configuration
110
+ $ cat config/_default/config.toml
111
+ [module]
112
+ [[module.imports]]
113
+ path = " github.com/manid2/hugo-xterm"
114
+
115
+ # update theme
116
+ hugo mod get -u
117
+ ```
118
+
119
+ For all below methods your site needs to point to hugo-xterm theme
120
+ subdirectory in configuration as below:
121
+
122
+ ``` bash
123
+ $ cat config/_default/config.toml
124
+ theme = " hugo-xterm"
125
+ ```
126
+
127
+ ### Method - Download and copy theme
128
+
129
+ Download the archived (i.e. .zip or tar.gz) theme from github repository
130
+ releases page. Extract and copy the contents into ` themes/hugo-xterm `
131
+ subdirectory in your site directory.
132
+
133
+ To update the theme just download a new release and overwrite the same
134
+ subdirectory.
135
+
136
+ This method is simple, can be automated with script and saves space on disk by
137
+ omitting the theme repository history.
138
+
139
+ ### Method - Using git clone
140
+
141
+ This method clones the theme repository with history into your site's themes
142
+ subdirectory which is useful if you want to control the history or make your
143
+ own private modifications to the theme.
144
+
145
+ ``` bash
146
+ cd < your-site-directory>
147
+ git clone https://github.com/manid2/hugo-xterm themes/hugo-xterm --depth=1
148
+
149
+ # update theme
150
+ cd themes/hugo-xterm
151
+ git pull
152
+ ```
153
+
154
+ ### Method - Using git submodule
155
+
156
+ This is similar to cloning the theme into subdirectory except using git
157
+ submodule which makes the theme acts a dependency of your site repository. It
158
+ lets git to control your site and its dependency this theme.
159
+
160
+ ``` bash
161
+ git submodule add --depth=1 https://github.com/manid2/hugo-xterm \
162
+ themes/hugo-xterm
163
+
164
+ # update theme
165
+ git submodule update --remote --merge
166
+ ```
97
167
98
168
Local development
99
169
-----------------
@@ -133,7 +203,6 @@ License
133
203
[ 3 ] : https://github.com/kaitlinmctigue/kaitlinmctigue.github.io
134
204
[ 4 ] : https://github.com/hakimel/reveal.js
135
205
[ 5 ] : https://wave.webaim.org/
136
- [ 6 ] : https://github.com/adityatelange/hugo-PaperMod/wiki/Installation
137
206
[ 7 ] : https://manid2.github.io/hugo-xterm/
138
207
[ 8 ] : https://en.wikipedia.org/wiki/HSL_and_HSV
139
208
[ 9 ] : https://github.com/alecthomas/chroma/
0 commit comments