blob: 77ffafcda227019c77647ac7f2857f1eff9adad7 (
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
---
weight: 3
title: "Theme Documentation - Built-in Shortcodes"
date: 2020-03-04T16:29:41+08:00
lastmod: 2020-03-04T16:29:41+08:00
draft: false
description: "Hugo provides multiple built-in shortcodes for author convenience and to keep your markdown content clean."
resources:
- name: "featured-image"
src: "featured-image.png"
tags: ["shortcodes"]
categories: ["documentation"]
---
**Hugo** provides multiple built-in shortcodes for author convenience and to keep your markdown content clean.
<!--more-->
Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.
But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.
To avoid this limitations, Hugo created [shortcodes](https://gohugo.io/extras/shortcodes/).
A shortcode is a simple snippet that can generate reasonable HTML code and conforms to Markdown's design philosophy.
Hugo ships with a set of predefined shortcodes that represent very common usage. These shortcodes are provided for author convenience and to keep your markdown content clean.
## 1 figure {#figure}
[Documentation of `figure`](https://gohugo.io/content-management/shortcodes#figure)
Example `figure` input:
```markdown
{{</* figure src="/images/lighthouse.jpg" title="Lighthouse (figure)" */>}}
```
The rendered output looks like this:
{{< figure src="/images/lighthouse.jpg" title="Lighthouse (figure)" >}}
The HTML looks like this:
```html
<figure>
<img src="/images/lighthouse.jpg"/>
<figcaption>
<h4>Lighthouse (figure)</h4>
</figcaption>
</figure>
```
## 2 gist
[Documentation of `gist`](https://gohugo.io/content-management/shortcodes#gist)
Example `gist` input:
```markdown
{{</* gist spf13 7896402 */>}}
```
The rendered output looks like this:
{{< gist spf13 7896402 >}}
The HTML looks like this:
```html
<script type="application/javascript" src="https://gist.github.com/spf13/7896402.js"></script>
```
## 3 highlight
[Documentation of `highlight`](https://gohugo.io/content-management/shortcodes#instagram)
Example `highlight` input:
```markdown
{{</* highlight html */>}}
<section id="main">
<div>
<h1 id="title">{{ .Title }}</h1>
{{ range .Pages }}
{{ .Render "summary"}}
{{ end }}
</div>
</section>
{{</* /highlight */>}}
```
The rendered output looks like this:
{{< highlight html >}}
<section id="main">
<div>
<h1 id="title">{{ .Title }}</h1>
{{ range .Pages }}
{{ .Render "summary"}}
{{ end }}
</div>
</section>
{{< /highlight >}}
## 4 instagram
[Documentation of `instagram`](https://gohugo.io/content-management/shortcodes#instagram)
Example `instagram` input:
```markdown
{{</* instagram BWNjjyYFxVx hidecaption */>}}
```
The rendered output looks like this:
## 5 param
[Documentation of `param`](https://gohugo.io/content-management/shortcodes#param)
Example `param` input:
```markdown
{{</* param description */>}}
```
The rendered output looks like this:
{{< param description >}}
## 6 ref and relref {#ref-and-relref}
[Documentation of `ref` and `relref`](https://gohugo.io/content-management/shortcodes#ref-and-relref)
## 7 tweet
[Documentation of `tweet`](https://gohugo.io/content-management/shortcodes#tweet)
Example `tweet` input:
```markdown
{{</* tweet 877500564405444608 */>}}
```
The rendered output looks like this:
{{< tweet 877500564405444608 >}}
## 8 vimeo
[Documentation of `vimeo`](https://gohugo.io/content-management/shortcodes#vimeo)
Example `vimeo` input:
```markdown
{{</* vimeo 146022717 */>}}
```
The rendered output looks like this:
{{< vimeo 146022717 >}}
## 9 youtube
[Documentation of `youtube`](https://gohugo.io/content-management/shortcodes#youtube)
Example `youtube` input:
```markdown
{{</* youtube w7Ft2ymGmfc */>}}
```
The rendered output looks like this:
{{< youtube w7Ft2ymGmfc >}}
|
