blob: 88bbda6b19df657a91efe57b3b8740e3c3a097fc (
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
# hugo-theme-hulga
> hugo + bulma = hulga
## Screenshot
build `hugoBasicExample` without any config of this theme
![screenshot](https://github.com/wlh320/hugo-theme-hulga/blob/main/images/screenshot.png)
## Demo
build hugo site with configs
[Demo site](https://v4.zilch40.wang)
[My Blog](https://blog.zilch40.wang)
## Features
- small & fast
- basic functions:
- category list&term pages
- tag list&term pages
- archives pages
- TOC sidebar
- `prefers-color-scheme` media support
- PWA support
## Install
1. clone to hugo site themes folder
```bash
git submodule add https://github.com/wlh320/hugo-theme-hulga.git themes/hulga
```
2. enable it in `config.toml`
```
theme = "hulga"
```
and then config it.
3. to use `postcss`, copy `package.json ` and `postcss.config.js` to the root of your site folder, then `npm install`
## Config
An example of avaliable params:
```toml
baseURL = "https://example.com"
languageCode = "zh-cn"
DefaultContentLanguage = "zh-cn"
title = "My New Hugo Site"
paginate = 10
theme = "hulga"
[params]
# change bulma's primary color
primaryColor = "#1793d0"
# subtitle on homepage
subtitle = "This is a subtitle"
# copyright text on footer
copyright = "Copyright © 2020 wlh. All rights reserved."
# enable katex rendering
math = true
# enable postcss, mainly for css purge (129kB->20kB->4.8kB gzipped, but this makes build slower)
postcss = true
# enable toc on post page
toc = true
# enable TOC auto collapse
autoCollapseToc = true
# enable prefers-color-scheme:dark
darkMedia = true
# enable hero section's is-bold effect
heroBold = true
# enable PWA, prepare your icons and DON'T forget to modify manifest.json
pwa = true
# to enable different hightlight themes in light/dark mode
[markup]
[markup.highlight]
noClasses = false
[menu]
[[menu.main]]
identifier = "index"
name = "首页"
url = "/"
weight = 1
[[menu.main]]
identifier = "archives"
name = "归档"
url = "/archives/"
weight = 2
[[menu.main]]
identifier = "about"
name = "关于"
url = "/about/"
weight = 3
[taxonomies]
category = "categories"
tag = "tags"
```
## Acknowledgement
本项目的诞生离不开以下开源项目:
- [hugo](https://gohugo.io/) 静态页面生成
- [bulma](https://bulma.io/) CSS框架
- [bulmaswatch](https://jenil.github.io/bulmaswatch/) 借用了其中的 dark 主题
- [purgecss](https://purgecss.com/) [cssnano](https://cssnano.co/) 缩减CSS文件大小
- [katex](https://katex.org/) $\LaTeX$ 公式渲染
- [anchorjs](https://github.com/bryanbraun/anchorjs) 添加锚链
- [tocbot](https://tscanlin.github.io/tocbot/) 生成目录
- [vanilla-back-to-top](https://github.com/vfeskov/vanilla-back-to-top) 回到顶部 (好懒,这都不自己写)
|