Configure FixIt

Lruihao included in Documentation and Getting Started

2024-03-07 2024-04-16 About 5800 words 28 minutes - views

/documentation/getting-started/configuration/cover.webp

Find out how to configure your Hugo FixIt site.

Configuration file

Hugo has some global configuration settings, which are beyond the scope of this article.

Before starting configuration, it is recommended that you execute the following command to copy the default hugo.toml of theme to your project:

1
2
3
mv hugo.toml hugo.old.toml
cp themes/FixIt/hugo.toml hugo.toml
echo "theme = 'FixIt'" >> hugo.toml

For advanced use, you can also split your configuration by environment, root configuration key, and language instead of a single site configuration file.

More details can be found in the Configure Hugo page.

Hugo has a simple yet powerful menu system.

According to the interface provided by Hugo, FixIt theme only realizes some functions, it is enough to meet the needs of most people and make users easier to use.

The following is a complete menu item configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[menu]
  [[menu.main]]
    identifier = ""
    #  Identifier of the parent menu item
    parent = ""
    # you can add extra information before the name (HTML format is supported), such as icons
    pre = ""
    # you can add extra information after the name (HTML format is supported), such as icons
    post = ""
    name = ""
    url = ""
    # title will be shown when you hover on this menu link
    title = ""
    weight = 1
    #  add user-defined content to menu items
    [menu.main.params]
      # add css class to a specific menu item
      class = ""
      # whether set as a draft menu item whose function is similar to a draft post/page
      draft = false
      #  add fontawesome icon to a specific menu item
      icon = ""
      #  set menu item type, optional values: ["mobile", "desktop"]
      type = ""

Sub Menu

In consideration of practicability and typesetting, the FixIt theme only supports two-tier nested menus, which can be configured through the parent field in the menu configuration.

The parent item of a menu item should be the identifier of another menu item, and the identifier should be unique in the menu.

In addition, you can also add content to the menu through the front matter of the configuration page (i.e. the .md-file).

Here is a yaml example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
---
title: Configure FixIt
author: Lruihao
menu:
  main:
    title: Find out how to configure your Hugo FixIt site.
    parent: documentation
    weight: 3
    params:
      icon: fa-brands fa-readme
# ...
---

Theme Configuration

In addition to Hugo global configuration, FixIt provides some theme configuration via the root configuration keys params.

A simple example:

1
2
3
4
5
6
7
8
baseURL = 'https://example.org/'
languageCode = 'en'
title = 'ABC Widgets, Inc.'
[params]
  version = "0.3.X"
  description = "This is my new Hugo FixIt site"
  keywords = ["Hugo", "FixIt"]
  # ...

All theme configuration settings are as follows:

version

string The FixIt theme version. e.g. 0.2.X, 0.2.15, v0.2.15 etc.

description

string The site description for SEO.

keywords

string array The site keywords for SEO.

defaultTheme

string The site default theme. Default is auto. The configuration value for defaultTheme can be one of:

light: light style for FixIt
dark: dark style for FixIt
auto: automatically switch between light and dark styles based on the user’s system preference

fingerprint

string Which hash function used for SRI, when empty, no SRI is used. The configuration value for fingerprint can be one of sha256, sha384, sha512, md5.

dateFormat

string The date format for the site. Default is 2006-01-02.

images

string array Website images for Open Graph and Twitter Cards.

enablePWA

bool Enable PWA. Default is false.

externalIcon

bool Whether to add external Icon for external links automatically. Default is false.

navigationReverse

bool Whether to reverse the order of the navigation menu. Default is false.

withSiteTitle

bool Whether to add site title to the title of every page. Default is true. Remember to set up your site title in hugo.toml (e.g. title = "title")

titleDelimiter

string Title delimiter when the site title is be added to the title of every page. Default is -.

indexWithSubtitle

bool Whether to add site subtitle to the title of index page. Default is false. Remember to set up your site subtitle by params.header.subtitle.name.

disableThemeInject

bool FixIt will, by default, inject a theme meta tag in the HTML head on the home page only. You can turn it off, but we would really appreciate if you don’t, as this is a good way to watch FixIt’s popularity on the rise. Default is false.

author

map The author Configuration.

1
2
3
4
5
6
[params]
  [params.author]
    name = ""
    email = ""
    link = ""
    avatar = ""

name: string The author’s name.
email: string The author’s email.
link: string The author’s link.
avatar: string The author’s avatar.

gitInfo

map The Git repository information (only then enableGitInfo is true).

1
2
3
4
5
6
[params]
  [params.gitInfo]
    repo = ""
    branch = "main"
    dir = "content"
    issueTpl = "title=[BUG]%20{title}&body=|Field|Value|%0A|-|-|%0A|Title|{title}|%0A|URL|{URL}|%0A|Filename|{sourceURL}|"

repo: string The public Git repository URL. e.g. https://github.com/hugo-fixit/docs
branch: string The public Git repository branch. Default is main.
dir: string The content directory path relative to the root of the repository.
issueTpl: string The issue template for reporting issue of the posts. Available template params: {title}, {URL}, {sourceURL}.

app

map The App icon Configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
[params]
  [params.app]
    name = ""
    shortName = ""
    noFavicon = false
    svgFavicon = ""
    iconColor = "#5bbad5"
    tileColor = "#da532c"
    [params.app.themeColor]
      light = "#f8f8f8"
      dark = "#252627"

title: string Optional site title override for the app when added to an iOS home screen or Android launcher.
noFavicon: bool Whether to omit favicon resource links. Default is false.
svgFavicon: string Modern SVG favicon to use in place of older style .png and .ico files.
iconColor: string Safari mask icon color. Default is #5bbad5.
tileColor: string Windows v8-10 tile color. Default is #da532c.
themeColor: map Android browser theme color.

light: string The light theme color. Default is #f8f8f8.
dark: string The dark theme color. Default is #252627.

search

map The Search Configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[params]
  [params.search]
    enable = false
    type = "fuse"
    contentLength = 4000
    placeholder = ""
    maxResultLength = 10
    snippetLength = 30
    highlightTag = "em"
    absoluteURL = false
    [params.search.algolia]
      index = ""
      appID = ""
      searchKey = ""
    [params.search.fuse]
      isCaseSensitive = false
      minMatchCharLength = 2
      findAllMatches = false
      location = 0
      threshold = 0.3
      distance = 100
      ignoreLocation = false
      useExtendedSearch = false
      ignoreFieldNorm = false

enable: bool Whether to enable search. Default is false.
type: string The type of search engine. The configuration value for type can be one of algolia, fuse. Default is fuse.
contentLength: int The max index length of the chunked content. Default is 4000.
placeholder: string The placeholder of the search bar. Default is "".
maxResultLength: int The max number of results length. Default is 10.
snippetLength: int The snippet length of the result. Default is 30.
highlightTag: string The HTML tag name of the highlight part in results. Default is em.
absoluteURL: bool Whether to use the absolute URL based on the baseURL in search index. Default is false.
algolia: map The Algolia Configuration.

index: string The Algolia index.
appID: string The Algolia appID.
searchKey: string The Algolia searchKey.

fuse: map The Fuse Configuration.

isCaseSensitive: bool Whether the search is case sensitive. Default is false.
minMatchCharLength: int The minimum number of characters that must be matched before a result is considered a match. Default is 2.
findAllMatches: bool Whether to find all matches. Default is false.
location: int The location. Default is 0.
threshold: float The threshold. Default is 0.3.
distance: int The distance. Default is 100.
ignoreLocation: bool Whether to ignore location. Default is false.
useExtendedSearch: bool Whether to use extended search. Default is false.
ignoreFieldNorm: bool Whether to ignore field norm. Default is false.

Based on algolia or Fuse.js, searching is supported in FixIt theme.

In order to generate index.json for searching, add JSON output file type to the home of the outputs part in your site configuration.

1
2
[outputs]
  home = ["HTML", "RSS", "JSON"]

Tips about algolia /guides/algolia-atomic

map The Header Configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
[params]
  [params.header]
    desktopMode = "sticky"
    mobileMode = "auto"
    [params.header.title]
      logo = ""
      name = ""
      pre = ""
      post = ""
      typeit = false
    [params.header.subtitle]
      name = ""
      typeit = false

desktopMode: string Desktop header mode. The configuration value for desktopMode can be one of sticky, normal, auto. Default is sticky.
mobileMode: string Mobile header mode. The configuration value for mobileMode can be one of sticky, normal, auto. Default is auto.
title: map The Header title Configuration.

logo: string URL of the LOGO.
name: string Title name.
pre: string You can add extra information before the name (HTML format is supported), such as icons.
post: string You can add extra information after the name (HTML format is supported), such as icons.
typeit: bool Whether to use typeit animation for title name. Default is false.

subtitle: map The Header subtitle Configuration.

name: string Subtitle name.
typeit: bool Whether to use typeit animation for subtitle name. Default is false.

map The Breadcrumb Configuration.

1
2
3
4
5
[params]
  [params.breadcrumb]
    enable = false
    sticky = false
    showHome = false

enable: bool Whether to enable breadcrumb. Default is false.
sticky: bool Whether to make the breadcrumb sticky. Default is false.
showHome: bool Whether to show the home link in the breadcrumb. Default is false.

map The Footer Configuration.

 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
[params]
  [params.footer]
    enable = true
    custom = ""
    copyright = true
    author = true
    since = ""
    gov = ""
    icp = ""
    license = ""
    [params.footer.powered]
      enable = true
      hugoLogo = true
      themeLogo = true
    [params.footer.siteTime]
      enable = false
      animate = true
      icon = "fa-solid fa-heartbeat"
      pre = ""
      value = ""
    [params.footer.order]
      powered = 0
      copyright = 0
      statistics = 0
      visitor = 0
      beian = 0

enable: bool Whether to enable footer. Default is true.
custom: string Custom content (HTML format is supported). For advanced use, see parameter params.customFilePath.footer.
copyright: bool Whether to show copyright info. Default is true.
author: bool Whether to show the author. Default is true.
since: int Site creation year.
gov: string Public network security only in China (HTML format is supported).
icp: string ICP info only in China (HTML format is supported).
license: string License info (HTML format is supported).
powered: map The Footer powered Configuration.

enable: bool Whether to show Hugo and theme info. Default is true.
hugoLogo: bool Whether to show Hugo logo. Default is true.
themeLogo: bool Whether to show theme logo. Default is true.

siteTime: map The Footer siteTime Configuration.

enable: bool Whether to show site creation time. Default is false.
animate: bool Whether to animate the site creation time. Default is true.
icon: string The icon of the site creation time. Default is fa-solid fa-heartbeat.
pre: string You can add extra information before the value (HTML format is supported).
value: string The value of the site creation time. e.g. 2021-12-18T16:15:22+08:00.

order: map The Footer order Configuration.

powered: int The order of the powered line. Default is 0.
copyright: int The order of the copyright line. Default is 0.
statistics: int The order of the statistics line. Default is 0.
visitor: int The order of the visitor line. Default is 0.
beian: int The order of the beian line. Default is 0.

The order value can be one of first, 0, 1, 2, 3, 4, 5, last.

section

map The Section page Configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[params]
  [params.section]
    paginate = 20
    dateFormat = "01-02"
    rss = 10
    [params.section.recentlyUpdated]
      enable = false
      rss = false
      days = 30
      maxCount = 10

paginate: int Special amount of posts in each section page. Default is 20.
dateFormat: string Date format (month and day). Default is 01-02.
rss: int Amount of RSS pages. Default is 10.
recentlyUpdated: map The Recently Updated posts Configuration.

enable: bool Whether to enable recently updated posts. Default is false.
rss: bool Whether to enable recently updated posts in RSS. Default is false.
days: int The days of recently updated posts. Default is 30.
maxCount: int The max count of recently updated posts. Default is 10.

list

map The List (category or tag) page Configuration.

1
2
3
4
5
[params]
  [params.list]
    paginate = 20
    dateFormat = "01-02"
    rss = 10

paginate: int Special amount of posts in each list page. Default is 20.
dateFormat: string Date format (month and day). Default is 01-02.
rss: int Amount of RSS pages. Default is 10.

map The TagCloud Configuration for tags page.

1
2
3
4
5
6
7
[params]
  [params.tagcloud]
    enable = false
    min = 14
    max = 32
    peakCount = 10
    orderby = "name"

enable: bool Whether to enable tagcloud. Default is false.
min: int Minimum font size in px. Default is 14.
max: int Maximum font size in px. Default is 32.
peakCount: int Maximum count of posts per tag. Default is 10.
orderby: string Order of tags. The configuration value for orderby can be one of name, count. Default is name.

home

map The Home page Configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[params]
  [params.home]
    paginate = 10
    [params.home.profile]
      enable = false
      gravatarEmail = ""
      avatarURL = ""
      avatarMenu = ""
      title = ""
      subtitle = ""
      typeit = true
      social = true
      disclaimer = ""
    [params.home.posts]
      enable = true
      paginate = 6

rss: int Amount of RSS pages. Default is 10.
profile: map The Home page profile Configuration.

enable: bool Whether to enable home page profile. Default is false.
gravatarEmail: string Gravatar Email for preferred avatar in home page.
avatarURL: string URL of avatar shown in home page.
avatarMenu: string Identifier of avatar menu link.
title: string Title shown in home page (HTML format is supported).
subtitle: string Subtitle shown in home page.
typeit: bool Whether to use typeit animation for subtitle. Default is true.
social: bool Whether to show social links. Default is true.
disclaimer: string Disclaimer (HTML format is supported).

posts: map The Home page posts Configuration.

enable: bool Whether to enable home page posts. Default is true.
paginate: int Special amount of posts in each home posts page. Default is 6.

map Social Configuration about the author.

The default data of all supported social links is located in themes/FixIt/assets/data/social.yaml, which is you can refer to.

You can directly set your ID to get a default social link and its icon:

1
2
[params.social]
  Mastodon = "@xxxx"

The social link generated is https://mastodon.technology/@xxxx.

Or You can set more options through a object:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[params.social]
  [params.social.Mastodon]
    # weight when arranging icons (the greater the weight, the later the icon is positioned)
    weight = 0
    # your social ID
    id = "@xxxx"
    # prefix of your social link
    prefix = "https://mastodon.social/"
    # content hovering on the icon
    title = "Mastodon"

typeit

map TypeIt Configuration.

1
2
3
4
5
6
7
[params]
  [params.typeit]
    speed = 100
    cursorSpeed = 1000
    cursorChar = "|"
    duration = -1
    loop = false

speed: int Typing speed between each step (measured in milliseconds). Default is 100.
cursorSpeed: int Blinking speed of the cursor (measured in milliseconds). Default is 1000.
cursorChar: string Character used for the cursor (HTML format is supported). Default is |.
duration: int Cursor duration after typing finishing (measured in milliseconds, -1 means unlimited). Default is -1.
loop: bool Whether your strings will continuously loop after completing. Default is false.

mermaid

map Mermaid Configuration.

1
2
3
[params]
  [params.mermaid]
    themes = ["default", "dark"]

themes: string array(2) Themes for Mermaid. See Mermaid Themes for available values.

pangu

map PanguJS Configuration.

1
2
3
4
[params]
  [params.pangu]
    enable = false
    selector = "article"

enable: bool Whether to enable PanguJS. Default is false.
selector: string The selector of PanguJS. Default is article.

watermark

map Watermark Configuration. See Watermark for more information.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
[params]
  [params.watermark]
    enable = false
    content = ""
    opacity = 0.1
    width = 150
    height = 20
    rowSpacing = 60
    colSpacing = 30
    rotate = 15
    fontSize = 0.85
    fontFamily = "inherit"

ibruce

map Busuanzi count Configuration.

1
2
3
4
[params]
  [params.ibruce]
    enable = false
    enablePost = false

enable: bool Whether to enable Busuanzi count. Default is false.
enablePost: bool Whether to enable Busuanzi count in post meta. Default is false.

verification

map Site verification code Configuration for Google/Bing/Yandex/Pinterest/Baidu/360/Sogou.

1
2
3
4
5
6
7
8
9
[params]
  [params.verification]
    google = ""
    bing = ""
    yandex = ""
    pinterest = ""
    baidu = ""
    so = ""
    sogou = ""

seo

map Site SEO Configuration.

1
2
3
4
[params]
  [params.seo]
    image = ""
    thumbnailUrl = ""

image: string Image URL.
thumbnailUrl: string Thumbnail URL.

analytics

map Analytics Configuration.

1
2
3
4
5
6
7
8
9
[params]
  [params.analytics]
    enable = false
    [params.analytics.google]
      id = ""
      anonymizeIP = true
    [params.analytics.fathom]
      id = ""
      server = ""

enable: bool Whether to enable analytics. Default is false.
google: map Google Analytics Configuration.

id: string Google Analytics ID.
anonymizeIP: bool Whether to anonymize IP. Default is true.

fathom: map Fathom Analytics Configuration.

id: string Fathom Analytics ID.
server: string Server URL for your tracker if you’re self hosting.

cookieconsent

map Cookie consent Configuration.

1
2
3
4
5
6
7
[params]
  [params.cookieconsent]
    enable = true
    [params.cookieconsent.content]
      message = ""
      dismiss = ""
      link = ""

enable: bool Whether to enable cookie consent. Default is true.
content: map Cookie consent content Configuration.

message: string The message of cookie consent.
dismiss: string The dismiss of cookie consent.
link: string The link of cookie consent.

cdn

map CDN Configuration for third-party library files.

1
2
3
[params]
  [params.cdn]
    data = "unpkg.yml"

data: string CDN data file name, disabled by default. The data file is located in themes/FixIt/assets/data/cdn/ directory. You can store your own data files in the same path under your project: assets/data/cdn/. The configuration value for data can be one of jsdelivr.yml, unpkg.yml, etc.

compatibility

map Compatibility Configuration.

1
2
3
4
[params]
  [params.compatibility]
    polyfill = false
    objectFit = false

polyfill: bool Whether to use Polyfill.io to be compatible with older browsers. Default is false.
objectFit: bool Whether to use object-fit-images to be compatible with older browsers. Default is false.

githubCorner

map GitHub banner in the top-right or top-left corner.

1
2
3
4
5
6
[params]
  [params.githubCorner]
    enable = false
    permalink = ""
    title = "View source on GitHub"
    position = "right"

enable: bool Whether to enable GitHub banner. Default is false.
permalink: string The URL of the GitHub repository. e.g. https://github.com/hugo-fixit/FixIt
title: string The title of the GitHub banner.
position: string The position of the GitHub banner. The configuration value for position can be one of left, right. Default is right.

gravatar

map Gravatar Configuration.

1
2
3
4
5
[params]
  [params.gravatar]
    enable = false
    host = "www.gravatar.com"
    style = ""

enable: bool Whether to enable Gravatar. Default is false.
Depends on the author’s email, if the author’s email is not set, the local avatar will be used.
host: string Gravatar host. e.g. www.gravatar.com, cn.gravatar.com etc. Default is www.gravatar.com.
style: string Gravatar style. The configuration value for style can be one of mp, identicon, monsterid, wavatar, retro, blank, robohash. Default is "".

backToTop

map Back to top Configuration.

1
2
3
4
[params]
  [params.backToTop]
    enable = true
    scrollpercent = false

enable: bool Whether to enable back to top. Default is true.
scrollpercent: bool Scroll percent label in b2t button. Default is false.

readingProgress

map Reading progress bar Configuration.

1
2
3
4
5
6
7
8
9
[params]
  [params.readingProgress]
    enable = false
    start = "left"
    position = "top"
    reversed = false
    light = ""
    dark = ""
    height = "2px"

enable: bool Whether to enable reading progress bar. Default is false.
start: string The start position of reading progress bar. The configuration value for start can be one of left, right. Default is left.
position: string The position of reading progress bar. The configuration value for position can be one of top, bottom. Default is top.
reversed: bool Whether to reverse the reading progress bar. Default is false.
light: string The light color of reading progress bar. Default is "".
dark: string The dark color of reading progress bar. Default is "".
height: string The height of reading progress bar. Default is 2px.

pace

map Progress bar in the top during page loading, based on Pace.js.

1
2
3
4
5
[params]
  [params.pace]
    enable = false
    color = "blue"
    theme = "minimal"

enable: bool Whether to enable pace. Default is false.
color: string The color of pace. All available colors: black, blue, green, orange, pink, purple, red, silver, white, yellow. Default is blue.
theme: string The theme of pace. All available themes: barber-shop, big-counter, bounce, center-atom, center-circle, center-radar, center-simple, corner-indicator, fill-left, flash, flat-top, loading-bar, mac-osx, material, minimal. Default is minimal.

customFilePath

map Define custom file paths and create your custom files in site directory layouts/partials/custom.

1
2
3
4
5
[params]
  [params.customFilePath]
    aside = "custom/aside.html"
    profile = "custom/profile.html"
    footer = "custom/footer.html"

dev

map Developer options.

1
2
3
4
5
6
7
8
[params]
  [params.dev]
    enable = false
    c4u = false
    githubToken = ""
    [params.dev.mDevtools]
      enable = false
      type = "vConsole"

enable: bool Whether to enable developer options. Default is false.
c4u: bool Whether to check for updates. Default is false.
githubToken: string GitHub token. Please do not expose to public!
mDevtools: map Mobile Devtools Configuration.

enable: bool Whether to enable mobile devtools. Default is false.
type: string The type of mobile devtools. The configuration value for type can be one of vConsole, eruda. Default is vConsole.

page

map The configuration of each page.

  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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
[params]
  [params.page]
    #  whether to enable the author's avatar of the post
    authorAvatar = true
    #  whether to hide a page from home page
    hiddenFromHomePage = false
    #  whether to hide a page from search results
    hiddenFromSearch = false
    #  whether to hide a page from RSS feed
    hiddenFromRss = false
    #  whether to hide a page from related posts
    hiddenFromRelated = false
    #  whether to enable twemoji
    twemoji = false
    # whether to enable lightgallery
    #  if set to "force", images in the content will be forced to shown as the gallery.
    lightgallery = false
    #  whether to enable the ruby extended syntax
    ruby = true
    #  whether to enable the fraction extended syntax
    fraction = true
    #  whether to enable the fontawesome extended syntax
    fontawesome = true
    # license info (HTML format is supported)
    license = '<a rel="license external nofollow noopener noreferrer" href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target="_blank">CC BY-NC-SA 4.0</a>'
    # whether to show link to Raw Markdown content of the post
    linkToMarkdown = true
    #  whether to show link to view source code of the post
    linkToSource = true
    #  whether to show link to edit the post
    linkToEdit = true
    #  whether to show link to report issue for the post
    linkToReport = true
    #  whether to show the full text content in RSS
    rssFullText = false
    #  Page style ["narrow", "normal", "wide", ...]
    pageStyle = "normal"
    #  Auto Bookmark Support
    # If true, save the reading progress when closing the page.
    autoBookmark = false
    #  whether to enable wordCount
    wordCount = true
    #  whether to enable readingTime
    readingTime = true
    #  end of post flag
    endFlag = ""
    #  whether to enable instant.page
    instantPage = false
    #  whether to enable collection list at the sidebar
    collectionList = false
    #  whether to enable collection navigation at the end of the post
    collectionNavigation = false

    #  Repost config
    [params.page.repost]
      enable = false
      url = ""
    #  Table of the contents config
    [params.page.toc]
      # whether to enable the table of the contents
      enable = true
      #  whether to keep the static table of the contents in front of the post
      keepStatic = false
      # whether to make the table of the contents in the sidebar automatically collapsed
      auto = true
      #  position of TOC ["left", "right"]
      position = "right"
    #  Display a message at the beginning of an article to warn the reader that its content might be expired
    [params.page.expirationReminder]
      enable = false
      # Display the reminder if the last modified time is more than 90 days ago
      reminder = 90
      # Display warning if the last modified time is more than 180 days ago
      warning = 180
      # If the article expires, close the comment or not
      closeComment = false
    #  page heading config
    [params.page.heading]
      # used with `markup.tableOfContents.ordered` parameter
      [params.page.heading.number]
        # whether to enable auto heading numbering
        enable = false
        [params.page.heading.number.format]
          h1 = "{title}"
          h2 = "{h2} {title}"
          h3 = "{h2}.{h3} {title}"
          h4 = "{h2}.{h3}.{h4} {title}"
          h5 = "{h2}.{h3}.{h4}.{h5} {title}"
          h6 = "{h2}.{h3}.{h4}.{h5}.{h6} {title}"
    #  KaTeX mathematical formulas (https://katex.org)
    [params.page.math]
      enable = true
      # default inline delimiter is $ ... $ and \( ... \)
      inlineLeftDelimiter = ""
      inlineRightDelimiter = ""
      # default block delimiter is $$ ... $$, \[ ... \], \begin{equation} ... \end{equation} and some other functions
      blockLeftDelimiter = ""
      blockRightDelimiter = ""
      # KaTeX extension copy_tex
      copyTex = true
      # KaTeX extension mhchem
      mhchem = true
    #  Code config
    [params.page.code]
      # whether to show the copy button of the code block
      copy = true
      #  whether to show the edit button of the code block
      edit = true
      # the maximum number of lines of displayed code by default
      maxShownLines = 10
    #  Mapbox GL JS config (https://docs.mapbox.com/mapbox-gl-js)
    [params.page.mapbox]
      # access token of Mapbox GL JS
      accessToken = ""
      # style for the light theme
      lightStyle = "mapbox://styles/mapbox/light-v9"
      # style for the dark theme
      darkStyle = "mapbox://styles/mapbox/dark-v9"
      # whether to add NavigationControl
      navigation = true
      # whether to add GeolocateControl
      geolocate = true
      # whether to add ScaleControl
      scale = true
      # whether to add FullscreenControl
      fullscreen = true
    #  [Experimental] cache remote images locally, see: https://github.com/hugo-fixit/FixIt/pull/362
    [params.page.cacheRemoteImages]
      enable = false
      # replace remote image url with local image url (place in public/images/remote/)
      replace = false
    #  Related content config (https://gohugo.io/content-management/related/)
    [params.page.related]
      enable = false
      count = 5
    #  Donate (Sponsor) settings
    [params.page.reward]
      enable = false
      animation = false
      # position relative to post footer, optional values: ["before", "after"]
      position = "after"
      # comment = "Buy me a coffee"
      #  display mode of QR code images, optional values: ["static", "fixed"], default: `static`
      mode = "static"
      [params.page.reward.ways]
        # wechatpay = "/images/wechatpay.png"
        # alipay = "/images/alipay.png"
        # paypal = "/images/paypal.png"
        # bitcoin = "/images/bitcoin.png"
    #  social share links in post page
    [params.page.share]
      enable = true
      Twitter = true
      Facebook = true
      Linkedin = false
      Whatsapp = true
      Pinterest = false
      Tumblr = false
      HackerNews = false
      Reddit = false
      VK = false
      Buffer = false
      Xing = false
      Line = true
      Instapaper = false
      Pocket = false
      Flipboard = false
      Weibo = true
      Myspace = true
      Blogger = true
      Baidu = false
      Odnoklassniki = false
      Evernote = true
      Skype = false
      Trello = false
      Mix = false
    #  Comment config
    [params.page.comment]
      enable = false
      #  Artalk comment config (https://artalk.js.org/)
      [params.page.comment.artalk]
        enable = false
        server = "https://yourdomain"
        site = "默认站点"
        placeholder = ""
        noComment = ""
        sendBtn = ""
        editorTravel = true
        flatMode = "auto"
        maxNesting = 3
        #  enable lightgallery support
        lightgallery = false
        locale = "" # 
        # 
        emoticons = ""
        nestMax = 2
        nestSort = "DATE_ASC" # ["DATE_ASC", "DATE_DESC", "VOTE_UP_DESC"]
        vote = true
        voteDown = false
        uaBadge = true
        listSort = true
        imgUpload = true
        preview = true
        versionCheck = true
      #  Disqus comment config (https://disqus.com)
      [params.page.comment.disqus]
        enable = false
        # Disqus shortname to use Disqus in posts
        shortname = ""
      #  Gitalk comment config (https://github.com/gitalk/gitalk)
      [params.page.comment.gitalk]
        enable = false
        owner = ""
        repo = ""
        clientId = ""
        clientSecret = ""
      # Valine comment config (https://github.com/xCss/Valine)
      [params.page.comment.valine]
        enable = false
        appId = ""
        appKey = ""
        placeholder = ""
        avatar = "mp"
        meta = ""
        requiredFields = ""
        pageSize = 10
        lang = ""
        visitor = true
        recordIP = true
        highlight = true
        enableQQ = false
        serverURLs = ""
        #  emoji data file name, default is "google.yml"
        # ["apple.yml", "google.yml", "facebook.yml", "twitter.yml"]
        # located in "themes/FixIt/assets/lib/valine/emoji/" directory
        # you can store your own data files in the same path under your project:
        # "assets/lib/valine/emoji/"
        emoji = ""
        commentCount = true # 
      #  Waline comment config (https://waline.js.org)
      [params.page.comment.waline]
        enable = false
        serverURL = ""
        pageview = false # 
        emoji = ["//unpkg.com/@waline/emojis@1.1.0/weibo"]
        meta = ["nick", "mail", "link"]
        requiredMeta = []
        login = "enable"
        wordLimit = 0
        pageSize = 10
        imageUploader = false # 
        highlighter = false # 
        comment = false # 
        texRenderer = false # 
        search = false # 
        recaptchaV3Key = "" # 
        reaction = false # 
      # Facebook comment config (https://developers.facebook.com/docs/plugins/comments)
      [params.page.comment.facebook]
        enable = false
        width = "100%"
        numPosts = 10
        appId = ""
        languageCode = ""
      #  Telegram comments config (https://comments.app)
      [params.page.comment.telegram]
        enable = false
        siteID = ""
        limit = 5
        height = ""
        color = ""
        colorful = true
        dislikes = false
        outlined = false
      #  Commento comment config (https://commento.io)
      [params.page.comment.commento]
        enable = false
      #  Utterances comment config (https://utteranc.es)
      [params.page.comment.utterances]
        enable = false
        # owner/repo
        repo = ""
        issueTerm = "pathname"
        label = ""
        lightTheme = "github-light"
        darkTheme = "github-dark"
      #  Twikoo comment config (https://twikoo.js.org/)
      [params.page.comment.twikoo]
        enable = false
        envId = ""
        region = ""
        path = ""
        visitor = true
        commentCount = true
        #  enable lightgallery support
        lightgallery = false
        #  enable Katex support
        katex = false
      #  Giscus comments config
      [params.page.comment.giscus]
        enable = false
        repo = ""
        repoId = ""
        category = ""
        categoryId = ""
        mapping = ""
        strict = "0" # 
        term = ""
        reactionsEnabled = "1"
        emitMetadata = "0"
        inputPosition = "bottom" # ["top", "bottom"]
        lightTheme = "light"
        darkTheme = "dark"
        lazyLoad = true
    #  Third-party library config
    [params.page.library]
      [params.page.library.css]
        # someCSS = "some.css"
        # located in "assets/"
        # Or
        # someCSS = "https://cdn.example.com/some.css"
      [params.page.library.js]
        # someJavascript = "some.js"
        # located in "assets/"
        # Or
        # someJavascript = "https://cdn.example.com/some.js"
    #  Page SEO config
    [params.page.seo]
      # image URL
      images = []
      # Publisher info
      [params.page.seo.publisher]
        name = ""
        logoUrl = ""

Markup Configuration

Configure rendering of markup to HTML via the root configuration keys markup.

This section only records some necessary configuration for the FixIt theme. For more details, see the Configure markup page.

1
2
3
4
5
6
[markup]
  [markup.highlight]
    codeFences = true
    lineNos = true
    lineNumbersInTable = true
    noClasses = false

Custom output formats

Hugo can output content in multiple formats. The FixIt theme takes advantage of this feature. In order to fully configure the theme, configure the following options into hugo.toml.

More details about the configuration of output formats can be found in the Custom output formats page.

 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
# 
[mediaTypes]
  # Options to make output .md files
  [mediaTypes."text/markdown"]
    suffixes = ["md"]
  # Options to make output .txt files
  [mediaTypes."text/plain"]
    suffixes = ["txt"]

[outputFormats]
  # Options to make output .md files
  [outputFormats.MarkDown]
    mediaType = "text/markdown"
    isPlainText = true
    isHTML = false
  #  Options to make output /archives/index.html file
  [outputFormats.archives]
    path = "archives"
    baseName = "index"
    mediaType = "text/html"
    isPlainText = false
    isHTML = true
    permalinkable = true
  #  Options to make output /offline/index.html file
  [outputFormats.offline]
    path = "offline"
    baseName = "index"
    mediaType = "text/html"
    isPlainText = false
    isHTML = true
    permalinkable = true
  #  Options to make output readme.md file
  [outputFormats.README]
    baseName = "readme"
    mediaType = "text/markdown"
    isPlainText = true
    isHTML = false
  #  Options to make output baidu_urls.txt file
  [outputFormats.baidu_urls]
    baseName = "baidu_urls"
    mediaType = "text/plain"
    isPlainText = true
    isHTML = false

# Options to make hugo output files, the optional values are below:
# home: ["HTML", "RSS", "JSON", "archives", "offline", "README", "baidu_urls"]
# page: ["HTML", "MarkDown"]
# section: ["HTML", "RSS"]
# taxonomy: ["HTML", "RSS"]
# term: ["HTML", "RSS"]
[outputs]
  home = ["HTML", "RSS", "JSON", "archives", "offline"]
  page = ["HTML", "MarkDown"]
  section = ["HTML", "RSS"]
  taxonomy = ["HTML"]
  term = ["HTML", "RSS"]

Favicon Generation

It is recommended to put your own favicons, browserconfig.xml and site.webmanifest files into the /static directory.

android-chrome-192x192.png
android-chrome-512x512.png
apple-touch-icon.png
browserconfig.xml
favicon-32x32.png
favicon-16x16.png
favicon.ico
mstile-150x150.png
safari-pinned-tab.svg

They’re easily created via https://realfavicongenerator.net/.