Skip to content

Commit

Permalink
chore(docs): update shortcodes docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dillonzq committed Apr 30, 2020
1 parent 4191e04 commit a0d222a
Show file tree
Hide file tree
Showing 8 changed files with 132 additions and 114 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A shortcode is a simple snippet that can generate reasonable HTML code and confo

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 {#figure}
## 1 figure {#figure}

[Documentation of `figure`](https://gohugo.io/content-management/shortcodes#figure)

Expand All @@ -53,7 +53,7 @@ The HTML looks like this:
</figure>
```

## gist
## 2 gist

[Documentation of `gist`](https://gohugo.io/content-management/shortcodes#gist)

Expand All @@ -73,7 +73,7 @@ The HTML looks like this:
<script type="application/javascript" src="https://gist.github.com/spf13/7896402.js"></script>
```

## highlight
## 3 highlight

[Documentation of `highlight`](https://gohugo.io/content-management/shortcodes#instagram)

Expand Down Expand Up @@ -105,7 +105,7 @@ The rendered output looks like this:
</section>
{{< /highlight >}}

## instagram
## 4 instagram

[Documentation of `instagram`](https://gohugo.io/content-management/shortcodes#instagram)

Expand All @@ -119,7 +119,7 @@ The rendered output looks like this:

{{< instagram BWNjjyYFxVx hidecaption >}}

## param
## 5 param

[Documentation of `param`](https://gohugo.io/content-management/shortcodes#param)

Expand All @@ -133,11 +133,11 @@ The rendered output looks like this:

{{< param description >}}

## ref and relref {#ref-and-relref}
## 6 ref and relref {#ref-and-relref}

[Documentation of `ref` and `relref`](https://gohugo.io/content-management/shortcodes#ref-and-relref)

## tweet
## 7 tweet

[Documentation of `tweet`](https://gohugo.io/content-management/shortcodes#tweet)

Expand All @@ -151,7 +151,7 @@ The rendered output looks like this:

{{< tweet 877500564405444608 >}}

## vimeo
## 8 vimeo

[Documentation of `vimeo`](https://gohugo.io/content-management/shortcodes#vimeo)

Expand All @@ -165,7 +165,7 @@ The rendered output looks like this:

{{< vimeo 146022717 >}}

## youtube
## 9 youtube

[Documentation of `youtube`](https://gohugo.io/content-management/shortcodes#youtube)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ A shortcode is a simple snippet that can generate reasonable HTML code and confo

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 {#figure}
## 1 figure {#figure}

[Documentation of `figure`](https://gohugo.io/content-management/shortcodes#figure)

Expand All @@ -58,7 +58,7 @@ The HTML looks like this:
</figure>
```

## gist
## 2 gist

[Documentation of `gist`](https://gohugo.io/content-management/shortcodes#gist)

Expand All @@ -78,7 +78,7 @@ The HTML looks like this:
<script type="application/javascript" src="https://gist.github.com/spf13/7896402.js"></script>
```

## highlight
## 3 highlight

[Documentation of `highlight`](https://gohugo.io/content-management/shortcodes#instagram)

Expand Down Expand Up @@ -110,7 +110,7 @@ The rendered output looks like this:
</section>
{{< /highlight >}}

## instagram
## 4 instagram

[Documentation of `instagram`](https://gohugo.io/content-management/shortcodes#instagram)

Expand All @@ -124,7 +124,7 @@ The rendered output looks like this:

{{< instagram BWNjjyYFxVx hidecaption >}}

## param
## 5 param

[Documentation of `param`](https://gohugo.io/content-management/shortcodes#param)

Expand All @@ -138,11 +138,11 @@ The rendered output looks like this:

{{< param description >}}

## ref and relref {#ref-and-relref}
## 6 ref and relref {#ref-and-relref}

[Documentation of `ref` and `relref`](https://gohugo.io/content-management/shortcodes#ref-and-relref)

## tweet
## 7 tweet

[Documentation of `tweet`](https://gohugo.io/content-management/shortcodes#tweet)

Expand All @@ -156,7 +156,7 @@ The rendered output looks like this:

{{< tweet 877500564405444608 >}}

## vimeo
## 8 vimeo

[Documentation of `vimeo`](https://gohugo.io/content-management/shortcodes#vimeo)

Expand All @@ -170,7 +170,7 @@ The rendered output looks like this:

{{< vimeo 146022717 >}}

## youtube
## 9 youtube

[Documentation of `youtube`](https://gohugo.io/content-management/shortcodes#youtube)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ shortcode 是一个简单代码段, 可以生成合理的 HTML 代码, 并且符
Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见的用法.
提供这些 shortcodes 是为了方便保持你的 Markdown 内容简洁.

## figure {#figure}
## 1 figure {#figure}

[`figure` 的文档](https://gohugo.io/content-management/shortcodes#figure)

Expand All @@ -54,7 +54,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见
</figure>
```

## gist
## 2 gist

[`gist` 的文档](https://gohugo.io/content-management/shortcodes#gist)

Expand All @@ -74,7 +74,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见
<script type="application/javascript" src="https://gist.github.com/spf13/7896402.js"></script>
```

## highlight
## 3 highlight

[`highlight` 的文档](https://gohugo.io/content-management/shortcodes#instagram)

Expand Down Expand Up @@ -106,7 +106,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见
</section>
{{< /highlight >}}

## instagram
## 4 instagram

[`instagram` 的文档](https://gohugo.io/content-management/shortcodes#instagram)

Expand All @@ -120,7 +120,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见

{{< instagram BWNjjyYFxVx hidecaption >}}

## param
## 5 param

[`param` 的文档](https://gohugo.io/content-management/shortcodes#param)

Expand All @@ -134,11 +134,11 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见

{{< param description >}}

## ref 和 relref {#ref-and-relref}
## 6 ref 和 relref {#ref-and-relref}

[`ref``relref` 的文档](https://gohugo.io/content-management/shortcodes#ref-and-relref)

## tweet
## 7 tweet

[`tweet` 的文档](https://gohugo.io/content-management/shortcodes#tweet)

Expand All @@ -152,7 +152,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见

{{< tweet 877500564405444608 >}}

## vimeo
## 8 vimeo

[`vimeo` 的文档](https://gohugo.io/content-management/shortcodes#vimeo)

Expand All @@ -166,7 +166,7 @@ Hugo 附带了一组预定义的 shortcodes, 它们实现了一些非常常见

{{< vimeo 146022717 >}}

## youtube
## 9 youtube

[`youtube` 的文档](https://gohugo.io/content-management/shortcodes#youtube)

Expand Down
Loading

0 comments on commit a0d222a

Please sign in to comment.