1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
---
title: "Configuration"
date: 2017-10-17T15:26:15Z
lastmod: 2019-10-26T15:26:15Z
draft: false
weight: 20
---
You may specify options in config.toml (or config.yaml/config.json) of your site to make use of this theme’s features.
For an example of `config.toml`, see [config.toml](https://github.com/thingsym/hugo-theme-techdoc/blob/master/exampleSite/config.toml) in exampleSite.
## Params
# Source Code repository section
description = "put your description"
github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
version = "0.9.8"
# Documentation repository section
# documentation repository (set edit link to documentation repository)
github_doc_repository = "https://github.com/thingsym/hugo-theme-techdoc"
github_doc_repository_path = ""
# Analytic section
google_analytics_id = "" # Your Google Analytics tracking id
tag_manager_container_id = "" # Your Google Tag Manager container id
google_site_verification = "" # Your Google Site Verification for Search Console
# Open Graph and Twitter Cards settings section
# Open Graph settings for each page are set on the front matter.
# See https://gohugo.io/templates/internal/#open-graph
# See https://gohugo.io/templates/internal/#twitter-cards
title = "Hugo Techdoc Theme"
images = ["images/og-image.png"] # Open graph images are placed in `static/images`
# Theme settings section
# Theme color
# See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
custom_font_color = ""
custom_background_color = ""
# Documentation Menu section
# Menu style settings
menu_style = "open-menu" # "open-menu" or "slide-menu" or "" blank is as no sidebar
# Date format
dateformat = "" # default "2 Jan 2006"
# See the format reference https://gohugo.io/functions/format/#hugo-date-and-time-templating-reference
# path name excluded from documentation menu
menu_exclusion = [
"archives",
"archive",
"blog",
"entry",
"post",
"posts",
]
# Algolia site search section
# See https://www.algolia.com/doc/
algolia_search_enable = true
algolia_indexName = "hugo-demo-techdoc"
algolia_appId = "7W4SAN4PLK"
algolia_apiKey = "cbf12a63ff72d9c5dc0c10c195cf9128" # Search-Only API Key
#### `description`
The document summary
default: `put your description`
#### `github_repository`
URL of souce code repository
default: `https://github.com/thingsym/hugo-theme-techdoc`
#### `version`
The version of souce code
default: `0.9.8`
#### `github_doc_repository`
URL of documentation repository for editting
default: `https://github.com/thingsym/hugo-theme-techdoc`
#### `github_doc_repository_path`
content directory path (when including the content directory in the repository)
default: `""`
#### `google_analytics_id`
ID of Google Analytics
default: `""`
#### `tag_manager_container_id`
Container ID of Google Tag Manager
default: `""`
#### `google_site_verification`
Content value in meta tag `google-site-verification` for Google Search Console
```
<meta name="google-site-verification" content="e7-viorjjfiihHIoowh8KLiowhbs" />
```
default: `""`
#### `title`
default open graph title for open graph
default: `"Hugo Techdoc Theme"`
#### `images`
default open graph image for open graph
Open graph images are placed in `static/images`.
default: `["images/og-image.png"]`
#### `custom_font_color`
Header font color
See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
default: `""`
#### `custom_background_color`
Header background color
See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
default: `""`
#### `menu_style`
Documentation Menu style, Open Menu or Slide Menu
default: `open-menu`
value: `open-menu` | `slide-menu`
#### `dateformat`
default: `""` as `2 Jan 2006`
#### `menu_exclusion`
Path name excluded from documentation menu
By default, we exclude commonly used folder names in blogs.
default: `[
"archives",
"archive",
"blog",
"entry",
"post",
"posts"
]`
#### `algolia_search_enable`
Enable Algolia search
default: `true`
value: `true` | `false`
#### `algolia_indexName`
Algolia index name
default: `hugo-demo-techdoc`
#### `algolia_appId`
Application id
default: `7W4SAN4PLK`
#### `algolia_apiKey`
Search-Only API Key
default: `cbf12a63ff72d9c5dc0c10c195cf9128`
|
