summaryrefslogtreecommitdiff
path: root/wiki/features/single-page-parameters.md
blob: 4f11e75fbf726d1c55805f740966b39e193f1b63 (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
---
title: "Single Page Parameters"
date: "2024-10-09"
summary: "Single Page Parameters parameters"
description: "Single Page Parameters parameters"
toc: false
readTime: false
autonumber: true
math: false
showTags: false
---

The following parameters apply to single pages, they are meant to be inserted in the `.md` files introductions, apart from the date format.

## Author

You can specify an author name to display and avatar path to use. Here is an example 
using an image from /static: 

```md
author: "Francesco"
authorAvatarPath: "/avatar.jpeg"
```

## Table of Contents

Show a table of contents at the beginning of the post.

```md
toc: true
```

## Sections Auto-numbering

Auto-number headings.

```md
autonumber: true
```

Note that headings should start from level two.

## Math Rendering

Enable math rendering.

```md
math: true
```

You may encounter issues rendering complex equations.
This is due to a [known issue](https://discourse.gohugo.io/t/one-of-several-latex-equations-is-not-rendered-by-katex/47790). 

A possible workaround is to wrap your equation in `{{< rawhtml >}}` tags: 

```
{{< rawhtml >}}
$$
...
$$
{{< rawhtml >}}
```

## Tags

Create tags associated with the post and decide to show them.

```md
tags: ["database", "java"]
showTags: false
```

## Display Read Time

Choose to display reading time.

```md
readTime: true
```

## Hide Back to Top

Choose to display back to top at the end of the page.

```md
hideBackToTop: true
```

## Hide Pagination Controls

Choose to display pagination controls at the end of the page.

```md
hidePagination: true
```

## Meta Description

You can specify the post meta description as follows: 

```md
description: "Your Description"
```

## Fediverse

You can include a [fediverse handle](https://blog.joinmastodon.org/2024/07/highlighting-journalism-on-mastodon/) in your posts.

```md
fediverse: "@username@instance.url"
```

## Date Format

You can decide the date format to apply to single posts by setting the following param in the toml file: 

```toml
[params]
singleDateFormat = '2 January 2006'
```