blob: 2f39bd46349e72c7b8bb00ca8745bb7113dcdb0c (
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
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
|
# Hugo Theme Tania
[](https://app.netlify.com/sites/hugo-tania/deploys)
A simple theme for bloggers.
## Demo
[Example Site](https://hugo-tania.netlify.app/)
## Introduction
Most of the styles for this theme come from [taniarascia.com](https://github.com/taniarascia/taniarascia.com)
I like it's style, so I transplant it to Hugo.
And is that why this theme called Tania.
Thank Tania Rascia again.
## Requirements
It's necessary to use **Hugo ≥ 0.78.0**.
Use Hugo Extended version (recommended) if you want to:
- Use the latest feature/fix from main branch
- Edit SCSS files
## Features
- Responsive and Mobile-Friendly
- Dark mode(It can switch automatically or manually)
- Footnotes(Float on the right side)
- Search with categories filter
## Installation
In your site's root dir
```bash
git submodule add https://github.com/WingLim/hugo-tania themes/hugo-tania
```
Edit your site config following [exampleSite/config.yaml](https://github.com/WingLim/hugo-tania/blob/main/exampleSite/config.yaml).
## Configuration
### Menu
You can custom header and footer menu.
```yaml
menu:
header:
- name: Articles
url: "/articles/"
footer:
- name: RSS
url: "/index.xml"
```
### Site Configuration
There are a few configuration options that you can add to your `config.yaml` file.
You can also see the `toml` example in [exampleSite/config.example.toml](https://github.com/WingLim/hugo-tania/blob/main/exampleSite/config.example.toml)
Notice: if you want use disqus as comment system in this theme, you need to set `disqusShortname` in `config` root and `comments` in `params`.
```yaml
params:
# Emoji will show before the blog title on site navbar.
titleEmoji: '😎'
# Logo will show before the blog title on site navbar.
titleLogo:
# Enable float footnotes.
# Default to true
enableFootnotes: true
# Limit how many categories filter show above search input.
# Default to 5
maxCategoryToShow: 10
# Show your socail information with icon on index bio with `_index.md` content.
socialOptions:
dev-to:
email:
facebook:
github:
instagram:
linkedin:
medium:
stack-overflow:
steam:
telegram:
twitter:
twitch:
whatsapp:
# Addtional option for meta SEO
siteName:
siteDesc:
author:
# Comments settings
comments:
enable: true
provider: disqus
```
## Layout
### Archives
`archives` layout is for showing all articles you write.
Add `articles.md` to site `content` dir, and write as below:
If you want to show it on site header, see [#Menu](#menu)
```markdown
---
title: Articles
subtitle: Posts, tutorials, snippets, musings, and everything else.
date: 2020-11-26
type: section
layout: "archives"
---
```
## Article Params
### Enable math formula render
For enable math formula render, add `katex: true` or `mathjax: true` in your article head, like:
Notice: You should enable only one `katex` or `mathjax` in a same time.
```markdown
---
title: Title
katex: true
---
Some content...
```
## Thanks to
- [hugo-theme-stack](https://github.com/CaiJimmy/hugo-theme-stack) for dark mode switch
- [hugo-prose](https://github.com/yihui/hugo-prose) for float footnotes
## License
[MIT](https://github.com/WingLim/hugo-tania/blob/main/LICENSE)
|
