summaryrefslogtreecommitdiff
path: root/README.md
blob: 18aea5c02a428fe8284afd9646bdcb41a2593691 (plain) (blame)
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
# Hugo Theme Puppet

> Ported Theme of [Hux Blog](https://github.com/Huxpro/huxpro.github.io), Thank [Huxpro](https://github.com/Huxpro) for designing such a flawless theme.

## Installation

```bash
$ git clone https://github.com/roninro/hugo-theme-puppet.git themes/puppet
```

## Configuration

Config.toml example

```toml
baseurl = "/"
title = "Puppet"
languageCode = "en-us"
paginate = 10 # Number of posts per page
theme = "puppet"

disqusShortname = "" # Enable Disqus comments by entering your Disqus shortname

enableInlineShortcodes = true
enableEmoji = true


[outputs]
home = ["HTML", "JSON"]

[taxonomies]
category = "categories"
tag = "tags"
series = "series" #

[markup]
[markup.highlight]
codeFences = true
guessSyntax = true
lineNos = true
lineNumbersInTable = false
style = "dracula"

[markup.goldmark.renderer]
unsafe = true

[menu]
[[menu.main]]
identifier = "home"
name = "Home"
url = "/"
weight = -100
[[menu.main]]
identifier = "about"
name = "About"
url = "/about/"
weight = 100
[[menu.main]]
identifier = "archive"
name = "Archive"
url = "/archive/"
weight = 10


[params]
author = "Puppet"
description = "A simple and clean theme for Hugo"
keywords = "blog,developer,personal"
img_home = "/img/home-bg.jpg"
img_404 = "/img/404-bg.jpg"

[params.sidebar]
enable = true
avatar = "/img/home-bg.jpg"
bio = "John Doe's personal website"

[params.social]
rss_enable = true
twitter = "johndoe"
facebook = "johndoe"
zhihu = "johndoe"
weibo = "johndoe"
github = "johndoe"
linkedin = "johndoe"

[[params.friends]]
name = "John Doe"
url = "https://gohugo.io"

[[params.friends]]
name = "John Doe"
url = "https://gohugo.io"

# See https://giscus.app/
[params.giscus]
enable = false
repo = ""
repo_id = ""
category = ""
category_id = ""
input_position = ""
theme = "light"
```

## Front Matter example

see [default.md](archetypes/default.md)

```markdown
+++
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
header_img: ""
short: false
toc = true
tags = []
categories = []
+++
```

## License

[MIT](LICENSE)