blob: c63e176a775ea7508a03db480c4b848389f2158c (
plain)
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
|
---
title: "Configuration"
date: 2017-10-17T15: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
# Souce Code repository section
description = "put your description"
github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
version = "0.2.0"
# Documentation repository section
# documentation repository (set edit link to documentation repository)
github_doc_repository = "https://github.com/thingsym/hugo-theme-techdoc"
# 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
# Theme settings section
dateformat = "" # default "2 Jan 2006"
# path name excluded from document menu
menu_exclusion = ["archives", "blog", "entry", "post", "posts"]
#### `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.2.0`
#### `github_doc_repository`
URL of documentation repository for editting
default: `https://github.com/thingsym/hugo-theme-techdoc`
#### `google_analytics_id`
ID of Google Analytics
default: `""`
Container ID of Google Tag Manager
#### `tag_manager_container_id`
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: `""`
#### `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", "blog", "entry", "post", "posts"]`
|
