30 KiB
weight, title, subtitle, date, lastmod, draft, author, authorLink, description, license, tags, categories, hiddenFromHomePage, featuredImage, featuredImagePreview, toc, autoCollapseToc, math, lightgallery, linkToMarkdown, share, comment
| weight | title | subtitle | date | lastmod | draft | author | authorLink | description | license | tags | categories | hiddenFromHomePage | featuredImage | featuredImagePreview | toc | autoCollapseToc | math | lightgallery | linkToMarkdown | share | comment | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 3 | Theme Documentation - Shortcodes | 2020-03-04T16:29:41+08:00 | 2020-03-04T16:29:41+08:00 | false | Dillon | https://dillonzq.com | LoveIt theme provides multiple shortcodes on top of built-in ones in Hugo. |
|
|
false | /images/theme-documentation-shortcodes/featured-image.jpg | true | true | false | true | true |
|
true |
LoveIt theme provides multiple shortcodes on top of built-in ones in Hugo.
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. A shortcode is a simple snippet that can generate reasonable HTML code and conforms to Markdown's design philosophy.
Hugo’s Built-in Shortcodes
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.
figure
Example figure input:
{{</* figure src="/images/theme-documentation-shortcodes/lighthouse.jpg" title="Lighthouse (figure)" */>}}
The rendered output looks like this:
{{< figure src="/images/theme-documentation-shortcodes/lighthouse.jpg" title="Lighthouse (figure)" >}}
The HTML looks like this:
<figure>
<img src="/images/theme-documentation-shortcodes/lighthouse.jpg"/>
<figcaption>
<h4>Lighthouse (figure)</h4>
</figcaption>
</figure>
gist
Example gist input:
{{</* gist spf13 7896402 */>}}
The rendered output looks like this:
{{< gist spf13 7896402 >}}
The HTML looks like this:
<script type="application/javascript" src="https://gist.github.com/spf13/7896402.js"></script>
highlight
Example highlight input:
{{</* 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 >}}
{{ .Title }}
{{ range .Pages }} {{ .Render "summary"}} {{ end }}instagram
Example instagram input:
{{</* instagram BWNjjyYFxVx hidecaption */>}}
The rendered output looks like this:
{{< instagram BWNjjyYFxVx hidecaption >}}
param
Example param input:
{{</* param description */>}}
The rendered output looks like this:
{{< param description >}}
ref and relref
Documentation of ref and relref
tweet
Example tweet input:
{{</* tweet 877500564405444608 */>}}
The rendered output looks like this:
{{< tweet 877500564405444608 >}}
vimeo
Example vimeo input:
{{</* vimeo 146022717 */>}}
The rendered output looks like this:
{{< vimeo 146022717 >}}
youtube
Example youtube input:
{{</* youtube w7Ft2ymGmfc */>}}
The rendered output looks like this:
{{< youtube w7Ft2ymGmfc >}}
LoveIt Shortcodes
LoveIt provides multiple shortcodes on top of existing ones.
style
style is a shortcode to insert custom style in your post.
The style shortcode has two positional parameters.
The first one is the custom style content.
And the second one is the HTML tag around the content you want to change style, and whose default value is p.
Example style input:
{{</* style "text-align: right" */>}}
This is a right-aligned paragraph.
{{</* /style */>}}
The rendered output looks like this:
{{< style "text-align: right" >}} This is a right-aligned paragraph. {{< /style >}}
link
{{< version 0.2.0 >}}
link shortcode is an alternative to Markdown link syntax. link shortcode can provide some other features and can be used in code blocks.
The link shortcode has the following named parameters:
-
href [required] (first positional parameter)
Destination of the link.
-
content [optional] (second positional parameter)
Content of the link, default is the value of href parameter.
Markdown or HTML format is supported.
-
title [optional] (third positional parameter)
titleattribute of the HTMLatag, which will be shown when hovering on the link. -
class [optional]
classattribute of the HTMLatag. -
rel [optional]
Additional
relattributes of the HTMLatag.
Example link input:
{{</* link "https://assemble.io" */>}}
Or
{{</* link href="https://assemble.io" */>}}
{{</* link "mailto:contact@revolunet.com" */>}}
Or
{{</* link href="mailto:contact@revolunet.com" */>}}
{{</* link "https://assemble.io" Assemble */>}}
Or
{{</* link href="https://assemble.io" content=Assemble */>}}
The rendered output looks like this:
- {{< link "https://assemble.io" >}}
- {{< link "mailto:contact@revolunet.com" >}}
- {{< link "https://assemble.io" Assemble >}}
Example link input with a title:
{{</* link "https://github.com/upstage/" Upstage "Visit Upstage!" */>}}
Or
{{</* link href="https://github.com/upstage/" content=Upstage title="Visit Upstage!" */>}}
The rendered output looks like this (hover over the link, there should be a tooltip):
{{< link "https://github.com/upstage/" Upstage "Visit Upstage!" >}}
image
{{< version 0.2.0 changed >}}
image shortcode is an alternative to figure shortcode. image shortcode can take full advantage of the dependent libraries of lazysizes and lightgallery.js.
The image shortcode has the following named parameters:
-
src [required] (first positional parameter)
URL of the image to be displayed.
-
alt [optional] (second positional parameter)
Alternate text for the image if the image cannot be displayed, default is the value of src parameter.
Markdown or HTML format is supported.
-
caption [optional] (third positional parameter)
Image caption.
Markdown or HTML format is supported.
-
title [optional]
Image title that will be shown when hovering on the image.
-
class [optional]
classattribute of the HTMLfiguretag. -
src_s [optional]
URL of the image thumbnail, used for lightgallery, default is the value of src parameter.
-
src_l [optional]
URL of the HD image, used for lightgallery, default is the value of src parameter.
-
height [optional]
heightattribute of the image. -
width [optional]
widthattribute of the image. -
linked [optional]
Whether the image needs to be hyperlinked, default is
true. -
rel [optional]
Additional
relattributes of the HTMLatag, if linked parameter is set totrue. -
large [optional]
Whether the image is large used for loading animation, if linked parameter is set to
false.
Example image input:
{{</* image src="/images/theme-documentation-shortcodes/lighthouse.jpg" caption="Lighthouse (`image`)" src-s="/images/theme-documentation-shortcodes/lighthouse-small.jpg" src-l="/images/theme-documentation-shortcodes/lighthouse-large.jpg" */>}}
The rendered output looks like this:
{{< image src="/images/theme-documentation-shortcodes/lighthouse.jpg" caption="Lighthouse (image)" src-s="/images/theme-documentation-shortcodes/lighthouse-small.jpg" src-l="/images/theme-documentation-shortcodes/lighthouse-large.jpg" >}}
admonition
The admonition shortcode supports 12 types of banners to help you put notice in your page.
Markdown or HTML format in the content is supported.
{{< admonition >}} A note banner {{< /admonition >}}
{{< admonition abstract >}} An abstract banner {{< /admonition >}}
{{< admonition info >}} A info banner {{< /admonition >}}
{{< admonition tip >}} A tip banner {{< /admonition >}}
{{< admonition success >}} A success banner {{< /admonition >}}
{{< admonition question >}} A question banner {{< /admonition >}}
{{< admonition warning >}} A warning banner {{< /admonition >}}
{{< admonition failure >}} A failure banner {{< /admonition >}}
{{< admonition danger >}} A danger banner {{< /admonition >}}
{{< admonition bug >}} A bug banner {{< /admonition >}}
{{< admonition example >}} An example banner {{< /admonition >}}
{{< admonition quote >}} A quote banner {{< /admonition >}}
The admonition shortcode has the following named parameters:
-
type [optional] (first positional parameter)
Type of the
admonitionbanner, default isnote. -
title [optional] (second positional parameter)
Title of the
admonitionbanner, default is the value of type parameter. -
details [optional] (third positional parameter)
Whether the content will be expandable/collapsible, default is
false.
Example admonition input:
{{</* admonition type=tip title="This is a tip" details=true */>}}
A **tip** banner
{{</* /admonition */>}}
Or
{{</* admonition tip "This is a tip" true */>}}
A **tip** banner
{{</* /admonition */>}}
The rendered output looks like this:
{{< admonition tip "This is a tip" true >}} A tip banner {{< /admonition >}}
mermaid
mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.
Just insert your mermaid code in the mermaid shortcode and that’s it.
Flowchart
Example flowchart mermaid input:
{{</* mermaid */>}}
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{Decision}
C -->|One| D[Result one]
C -->|Two| E[Result two]
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} graph LR; A[Hard edge] -->|Link text| B(Round edge) B --> C{Decision} C -->|One| D[Result one] C -->|Two| E[Result two] {{< /mermaid >}}
Sequence Diagram
Example sequence diagram mermaid input:
{{</* mermaid */>}}
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}}
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts
prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
{{< /mermaid >}}
GANTT
Example GANTT mermaid input:
{{</* mermaid */>}}
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :1d
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to mermaid :1d {{< /mermaid >}}
Class Diagram
Example class diagram mermaid input:
{{</* mermaid */>}}
classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} classDiagram Class01 <|-- AveryLongClass : Cool Class03 -- Class04 Class05 o-- Class06 Class07 .. Class08 Class09 --> C2 : Where am i? Class09 -- C3 Class09 --|> Class07 Class07 : equals() Class07 : Object[] elementData Class01 : size() Class01 : int chimp Class01 : int gorilla Class08 <--> C2: Cool label {{< /mermaid >}}
State Diagram
Example state diagram mermaid input:
{{</* mermaid */>}}
stateDiagram
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} stateDiagram [] --> Still Still --> [] Still --> Moving Moving --> Still Moving --> Crash Crash --> [*] {{< /mermaid >}}
Git Graph
Example git graph mermaid input:
{{</* mermaid */>}}
gitGraph:
options
{
"nodeSpacing": 100,
"nodeRadius": 10
}
end
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} gitGraph: options { "nodeSpacing": 100, "nodeRadius": 10 } end commit branch newbranch checkout newbranch commit commit checkout master commit commit merge newbranch {{< /mermaid >}}
Pie
Example pie mermaid input:
{{</* mermaid */>}}
pie
"Dogs" : 386
"Cats" : 85
"Rats" : 15
{{</* /mermaid */>}}
The rendered output looks like this:
{{< mermaid >}} pie "Dogs" : 386 "Cats" : 85 "Rats" : 15 {{< /mermaid >}}
echarts
ECharts is a library helping you to generate interactive data visualization.
The basic chart types ECharts supports include line series, bar series, scatter series, pie charts, candle-stick series, boxplot series for statistics, map series, heatmap series, lines series for directional information, graph series for relationships, treemap series, sunburst series, parallel series for multi-dimensional data, funnel series, gauge series. And it's extremely easy to create a combinition of them with ECharts.
Just insert your ECharts option in JSON/YAML/TOML format in the echarts shortcode and that’s it.
Example echarts input in JSON format:
{{</* echarts */>}}
{
"title": {
"text": "Summary Line Chart",
"top": "2%",
"left": "center"
},
"tooltip": {
"trigger": "axis"
},
"legend": {
"data": ["Email Marketing", "Affiliate Advertising", "Video Advertising", "Direct View", "Search Engine"],
"top": "10%"
},
"grid": {
"left": "5%",
"right": "5%",
"bottom": "5%",
"top": "20%",
"containLabel": true
},
"toolbox": {
"feature": {
"saveAsImage": {
"title": "Save as Image"
}
}
},
"xAxis": {
"type": "category",
"boundaryGap": false,
"data": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
},
"yAxis": {
"type": "value"
},
"series": [
{
"name": "Email Marketing",
"type": "line",
"stack": "Total",
"data": [120, 132, 101, 134, 90, 230, 210]
},
{
"name": "Affiliate Advertising",
"type": "line",
"stack": "Total",
"data": [220, 182, 191, 234, 290, 330, 310]
},
{
"name": "Video Advertising",
"type": "line",
"stack": "Total",
"data": [150, 232, 201, 154, 190, 330, 410]
},
{
"name": "Direct View",
"type": "line",
"stack": "Total",
"data": [320, 332, 301, 334, 390, 330, 320]
},
{
"name": "Search Engine",
"type": "line",
"stack": "Total",
"data": [820, 932, 901, 934, 1290, 1330, 1320]
}
]
}
{{</* /echarts */>}}
The same in YAML format:
{{</* echarts */>}}
title:
text: Summary Line Chart
top: 2%
left: center
tooltip:
trigger: axis
legend:
data:
- Email Marketing
- Affiliate Advertising
- Video Advertising
- Direct View
- Search Engine
top: 10%
grid:
left: 5%
right: 5%
bottom: 5%
top: 20%
containLabel: true
toolbox:
feature:
saveAsImage:
title: Save as Image
xAxis:
type: category
boundaryGap: false
data:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday
yAxis:
type: value
series:
- name: Email Marketing
type: line
stack: Total
data:
- 120
- 132
- 101
- 134
- 90
- 230
- 210
- name: Affiliate Advertising
type: line
stack: Total
data:
- 220
- 182
- 191
- 234
- 290
- 330
- 310
- name: Video Advertising
type: line
stack: Total
data:
- 150
- 232
- 201
- 154
- 190
- 330
- 410
- name: Direct View
type: line
stack: Total
data:
- 320
- 332
- 301
- 334
- 390
- 330
- 320
- name: Search Engine
type: line
stack: Total
data:
- 820
- 932
- 901
- 934
- 1290
- 1330
- 1320
{{</* /echarts */>}}
The same in TOML format:
{{</* echarts */>}}
[title]
text = "Summary Line Chart"
top = "2%"
left = "center"
[tooltip]
trigger = "axis"
[legend]
data = [
"Email Marketing",
"Affiliate Advertising",
"Video Advertising",
"Direct View",
"Search Engine"
]
top = "10%"
[grid]
left = "5%"
right = "5%"
bottom = "5%"
top = "20%"
containLabel = true
[toolbox]
[toolbox.feature]
[toolbox.feature.saveAsImage]
title = "Save as Image"
[xAxis]
type = "category"
boundaryGap = false
data = [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
[yAxis]
type = "value"
[[series]]
name = "Email Marketing"
type = "line"
stack = "Total"
data = [
120.0,
132.0,
101.0,
134.0,
90.0,
230.0,
210.0
]
[[series]]
name = "Affiliate Advertising"
type = "line"
stack = "Total"
data = [
220.0,
182.0,
191.0,
234.0,
290.0,
330.0,
310.0
]
[[series]]
name = "Video Advertising"
type = "line"
stack = "Total"
data = [
150.0,
232.0,
201.0,
154.0,
190.0,
330.0,
410.0
]
[[series]]
name = "Direct View"
type = "line"
stack = "Total"
data = [
320.0,
332.0,
301.0,
334.0,
390.0,
330.0,
320.0
]
[[series]]
name = "Search Engine"
type = "line"
stack = "Total"
data = [
820.0,
932.0,
901.0,
934.0,
1290.0,
1330.0,
1320.0
]
{{</* /echarts */>}}
The rendered output looks like this:
{{< echarts >}} { "title": { "text": "Summary Line Chart", "top": "2%", "left": "center" }, "tooltip": { "trigger": "axis" }, "legend": { "data": ["Email Marketing", "Affiliate Advertising", "Video Advertising", "Direct View", "Search Engine"], "top": "10%" }, "grid": { "left": "5%", "right": "5%", "bottom": "5%", "top": "20%", "containLabel": true }, "toolbox": { "feature": { "saveAsImage": { "title": "Save as Image" } } }, "xAxis": { "type": "category", "boundaryGap": false, "data": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"] }, "yAxis": { "type": "value" }, "series": [ { "name": "Email Marketing", "type": "line", "stack": "Total", "data": [120, 132, 101, 134, 90, 230, 210] }, { "name": "Affiliate Advertising", "type": "line", "stack": "Total", "data": [220, 182, 191, 234, 290, 330, 310] }, { "name": "Video Advertising", "type": "line", "stack": "Total", "data": [150, 232, 201, 154, 190, 330, 410] }, { "name": "Direct View", "type": "line", "stack": "Total", "data": [320, 332, 301, 334, 390, 330, 320] }, { "name": "Search Engine", "type": "line", "stack": "Total", "data": [820, 932, 901, 934, 1290, 1330, 1320] } ] } {{< /echarts >}}
music
The music shortcode embeds a responsive music player based on APlayer and MetingJS.
There are three ways to use it the music shortcode.
Custom Music URL
The music shortcode has the following named parameters by custom music URL:
-
server [required]
URL of the custom music.
-
name [optional]
Name of the custom music.
-
artist [optional]
Artist of the custom music.
-
cover [required]
URL of the custom music cover.
Example music input by custom music URL:
{{</* music url="https://rainymood.com/audio1110/0.m4a" name=rainymood artist=rainymood cover="https://rainymood.com/i/badge.jpg" */>}}
The rendered output looks like this:
{{< music url="https://rainymood.com/audio1110/0.m4a" name=rainymood artist=rainymood cover="https://rainymood.com/i/badge.jpg" >}}
Music Platform URL Automatic Identification
The music shortcode has one named parameter by music platform URL automatic identification:
-
auto [required] (first positional parameter)
URL of the music platform URL for automatic identification, which supports
netease,tencentandxiamimusic platform.
Example music input by music platform URL automatic identification:
{{</* music auto="https://music.163.com/#/playlist?id=60198" */>}}
Or
{{</* music "https://music.163.com/#/playlist?id=60198" */>}}
The rendered output looks like this:
{{< music auto="https://music.163.com/#/playlist?id=60198" >}}
Custom Server, Type and ID
The music shortcode has the following named parameters by custom music platform:
-
server [required] (first positional parameter)
[
netease,tencent,kugou,xiami,baidu]Music platform.
-
type [required] (second positional parameter)
[
song,playlist,album,search,artist]Type of the music.
-
id [required] (third positional parameter)
Song ID, or playlist ID, or album ID, or search keyword, or artist ID.
Example music input by custom music platform:
{{</* music server="netease" type="song" id="1868553" */>}}
Or
{{</* music netease song 1868553 */>}}
The rendered output looks like this:
{{< music netease song 1868553 >}}
Other Parameters
The music shortcode has other named parameters applying to the above three ways:
-
theme [optional]
Main color of the music player, default is
#a9a9b3. -
fixed [optional]
Whether to enable fixed mode, default is
false. -
mini [optional]
Whether to enable mini mode, default is
false. -
autoplay [optional]
Whether to autoplay music, default is
false. -
volume [optional]
Default volume when the player is first opened, which will be remembered in the browser, default is
0.7. -
mutex [optional]
Whether to pause other players when this player starts playing, default is
true.
The music shortcode has the following named parameters only applying to the type of music list:
-
loop [optional]
[
all,one,none]Loop mode of the music list, default is
none. -
order [optional]
[
list,random]Play order of the music list, default is
list. -
list-folded [optional]
Whether the music list should be folded at first, default is
false. -
list-max-height [optional]
Max height of the music list, default is
340px.
bilibili
The bilibili shortcode embeds a responsive video player for bilibili videos.
When the video only has one part, only the av ID of the video is required, e.g.:
https://www.bilibili.com/video/av47027633
Example bilibili input:
{{</* bilibili 47027633 */>}}
Or
{{</* bilibili av=47027633 */>}}
The rendered output looks like this:
{{< bilibili av=47027633 >}}
When the video has multiple parts, in addition to the av ID of the video,
p is also required, whose default value is 1, e.g.:
https://www.bilibili.com/video/av36570401?p=3
Example bilibili input with p:
{{</* bilibili 36570401 3 */>}}
Or
{{</* bilibili av=36570401 p=3 */>}}
The rendered output looks like this:
{{< bilibili av=36570401 p=3 >}}
typeit
The typeit shortcode provides typing animation based on TypeIt.
Just insert your content in the typeit shortcode and that’s it.
Simple Content
Simple content is allowed in Markdown format and without rich block content such as images and more...
Example typeit input:
{{</* typeit */>}}
This is a *paragraph* with **typing animation** based on [TypeIt](https://typeitjs.com/)...
{{</* /typeit */>}}
The rendered output looks like this:
{{< typeit >}} This is a paragraph with typing animation based on TypeIt... {{< /typeit >}}
Alternatively, you can use custom HTML tags.
Example typeit input with h4 tag:
{{</* typeit tag=h4 */>}}
This is a *paragraph* with **typing animation** based on [TypeIt](https://typeitjs.com/)...
{{</* /typeit */>}}
The rendered output looks like this:
{{< typeit tag=h4 >}} This is a paragraph with typing animation based on TypeIt... {{< /typeit >}}
Code Content
Code content is allowed and will be highlighted by named parameter code for the type of code language.
Example typeit input with code:
{{</* typeit code=java */>}}
public class HelloWorld {
public static void main(String []args) {
System.out.println("Hello World");
}
}
{{</* /typeit */>}}
The rendered output looks like this:
{{< typeit code=java >}} public class HelloWorld { public static void main(String []args) { System.out.println("Hello World"); } } {{< /typeit >}}
Group Content
All typing animations start at the same time by default.
But sometimes you may want to start a set of typeit contents in order.
A set of typeit contents with the same value of named parameter group will start typing animation in sequence.
Example typeit input with group:
{{</* typeit group=paragraph */>}}
**First** this paragraph begins
{{</* /typeit */>}}
{{</* typeit group=paragraph */>}}
**Then** this paragraph begins
{{</* /typeit */>}}
The rendered output looks like this:
{{< typeit group=paragraph >}} First this paragraph begins {{< /typeit >}}
{{< typeit group=paragraph >}} Then this paragraph begins {{< /typeit >}}