Welcome to mirror list, hosted at ThFree Co, Russian Federation.

Enabling-and-Disabling-Features.md - github.com/AmazingRise/hugo-theme-diary.wiki.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 46d42d60234bddfbf33af3c01ec1b1b004e446a2 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
## Table Of Contents

* [Disable Table of Contents](https://github.com/AmazingRise/hugo-theme-diary/wiki/Enabling-and-Disabling-Features#disable-table-of-contents)

* [Disable Dark Mode](https://github.com/AmazingRise/hugo-theme-diary/wiki/Enabling-and-Disabling-Features#disable-dark-mode)

* [Add or disable comment area](https://github.com/AmazingRise/hugo-theme-diary/wiki/Enabling-and-Disabling-Features#add-comment-area)

## Disable Table of Contents

### Globally

Add `disableToC=true` to the section of `[param]` in your `config.toml`.
Then you will not see it.

### Apply for single page

Add `disableToC: true` in the front matter of the page.
Then you will disable it in the very page.

## Disable Dark Mode

Add `disableDarkMode=true` to the section of `[param]` in your `config.toml`.
Then you will not see it.

## Enable or disable comment area

Now, this theme support these comment service:
- LiveRe
- Gitalk
- Disqus
- Valine

### Enabling
#### Gitalk
Edit your `config.toml` in the hugo website's root directory.

Add the following line to the section `[params]`
```toml
enableGitalk = true
```
Then add following lines behind:
```toml
[params.gitalk]
  owner = "user"
  repo = "repo name"
  client_id = "your client id"
  client_secret = "your client secret"
```
(Modify to suit your condition.)

Notice: Gitalk will not shown in offline preview server.(Launched by `hugo server`)
#### Disqus
Hugo originally supports Disqus, and I added the disqus to the theme.

But due to my network environment, I haven't had it tested.

To add a disqus comment service, please add a line to `config.toml` in the root directory:

```toml
disqusShortname = "Your disqus short name."
```

#### LiveRe!

Edit your `config.toml` in the hugo website's root directory.

Add the following line to the section `[params]`
```toml
livereId = "xxxx"
```

"xxxx" stands for the value of `data-uid` in your LiveRe HTML code.

#### Valine
Edit your `config.toml` in the hugo website's root directory.

Add the following line to the section `[params]`
```toml
enableValine = true
```
Then add following lines behind:
```toml
[params.valine]
  appId = "Your app ID of leancloud"
  appKey = "Your app key of leancloud"
  avator = "avator type"
```

`avator` is optional. For details, [click here](https://valine.js.org/avatar.html).

#### Other comment service

Welcome to open an issue or Pull Request for adding a new comment service.

If I'm free then, I will add it. :P

---

### Disabling
#### Disable the comment area in one post
If you wanna to disable the comment area in a specific post, please add a line in the metadata area of the post:
```
comment : false
```
A more detailed description of the posts' meta data is [here](https://github.com/AmazingRise/hugo-theme-diary/wiki/Post's-meta-data).

#### Disable it globally
Please remove the settings item referred in "Add comment area".

The comment area will not be shown.