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
|
# [harbor](https://themes.gohugo.io/harbor/) - Simple Hugo Theme
[](https://sonarcloud.io/dashboard?id=matsuyoshi30_harbor)
Simple and minimal personal blog theme for [Hugo](https://gohugo.io/).
[Here](https://themes.gohugo.io/theme/harbor/) is the demo link.
## Features
- Support tags and categories and archives
- Google Analytics integration
- Responsive
- Dark mode
- Syntax Highlight (see [Hugo doc](https://gohugo.io/content-management/syntax-highlighting/))
- Search entire blog posts
- Table Of Contents
- Disqus
## Installation & Update
```
$ # install
$ mkdir themes
$ cd themes
$ git submodule add https://github.com/matsuyoshi30/harbor.git harbor
$ # update
$ git submodule update --remote --merge
```
If you want to know more information, see [Hugo doc](https://gohugo.io/themes/installing/).
## Usage
When you manually create files by following [quick start (step4)](https://gohugo.io/getting-started/quick-start/#step-4-add-some-content), you should command `hugo new post/<filename>.md` instead of `hugo new posts/<filename>.md` because some styles are specified by the class name (like `post-heading`) in the [main.css](./static/css/main.css).
#### `config.toml` example
```toml
theme = "harbor"
baseurl = "https://example.com/"
title = "Hugo Themes"
paginate = 3
languageCode = "en"
DefaultContentLanguage = "en"
enableInlineShortcodes = true
footnoteReturnLinkContents = "^"
# Optional
# If you use googleAnalytics, you set top-level options in config.toml to the beginning of the config file like other top-level options.
googleAnalytics = "UA-XXXXXXXX-XX"
# and disqus too.
disqusShortName = "yourdisqusshortname"
[Author]
name = "Hugo Author"
[outputs]
section = ["JSON", "HTML"]
[[params.nav]]
identifier = "about"
name = "About"
icon = "fas fa-user fa-lg"
url = "/about/"
weight = 3
[[params.nav]]
identifier = "tags"
name = "Tags"
icon = "fas fa-tag fa-lg"
url = "tags"
weight = 3
[[params.nav]]
identifier = "categories"
name = "Category"
icon = "fas fa-folder-open fa-lg"
url = "categories"
weight = 3
[[params.nav]]
identifier = "search"
name = "Search"
icon = "fas fa-search fa-lg"
url = "search"
weight = 3
[[params.nav]]
identifier = "archives"
name = "Archives"
icon = "fas fa-archive fa-lg"
url = "archives"
weight = 3
[params.logo]
url = "icon.png" # static/images/icon.png
width = 50
height = 50
alt = "Logo"
```
Change favicon(static/favicon.ico) and icon(static/images/icon.png)!
If you don't change them, your favicon and icon are my face :)
#### Search entire blog posts
You should make ```search.md``` in content directory.
```
---
title: "Search"
---
{{<search>}}
```
#### TOC
If you want to use TableOfContent, you need to write words greater than 400, and set `true` frontmatter `toc`.
#### Back To Top Button
If you want to use Back To Top Button, you need to write words greater than 400, and set `true` frontmatter `backtotop`.
#### Archives
If you want archive page, generate `archive.md` file in `content` directory.
```
$ hugo new archives.md
```
```
+++
title: "Archive page"
type: myarchivetype
+++
```
## Frontmatter example
```
+++
title = "Article title here"
date = 2020-02-15T20:00:00+09:00
tags = ["tags here"]
draft = false
toc = false
backtotop = false
disable_comment = true <!-- disable disqus -->
+++
# Title
<!-- when toc is true and post wordcounts is greater than 400 -->
## Contents
```
## Development
1. Install Node.js and npm, the Node.js package manager.
2. The package.json file in your new sub-theme contains the versions of all the Node.js software you need.
To install them run:
```
$ npm install
```
3. After fixing files in `static` dir, run `build` command to generate `bundle.js`
```
# for development version
$ npm run build-dev
# for production version
$ npm run build-prod
```
## LICENSE
[MIT](./LICENSE).
|
