github/hugo-geekblog
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekblog.git synced 2024-11-15 01:30:42 +00:00
Code Issues Projects Releases Wiki Activity
92ed33fe25
hugo-geekblog/exampleSite/content/posts/advanced/shortcodes.md

15 KiB
Raw Blame History

title date authors tags geekblogToC
Shortcodes 2021-05-23T20:00:00+01:00
john-doe
Documentation
Shortcodes
1

The theme bundles some handy shortcodes that tries to cover common situations.

{{< toc >}}

Buttons

Buttons are styled links that can lead to local page or external link.

Usage

{{</* button relref="/" [class="...", size="large|regular"] */>}}Get Home{{</* /button */>}}
{{</* button href="https://github.com/thegeeklab/hugo-geekblog" */>}}Contribute{{</* /button */>}}

Attributes

{{< propertylist name=shortcode-buttons sort=name order=asc >}}

Example

{{< button relref="/" >}}Get Home{{< /button >}} {{< button href="https://github.com/thegeeklab/hugo-geekblog" >}}Contribute{{< /button >}}

Columns

The Columns shortcode can be used to organize content side-by-side (horizontally) for better readability.

Usage

{{</* columns [size="small|regular|large"] */>}} <!-- begin columns block -->
# Left Content
Dolor sit, sumo unique argument um no ...

<---> <!-- magic sparator, between columns -->

# Mid Content
Dolor sit, sumo unique argument um no ...

<---> <!-- magic sparator, between columns -->

# Right Content
Dolor sit, sumo unique argument um no ...
{{</* /columns */>}}

Attributes

{{< propertylist name=shortcode-columns sort=name order=asc >}}

Example

{{< columns >}}

Left

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo.

<--->

Mid Content

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re.

<--->

Right Content

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo. {{< /columns >}}

Emojify

Emoji can be enabled in a Hugo project in a number of ways.

The emojify function can be called directly in templates or Inline Shortcodes. To enable emoji globally, set enableEmoji to true in your site's configuration and then you can type emoji shorthand codes directly in content files.

Example

Output Inline Shortcode
{{< emojify "🙈" >}} :see_no_evil: {{</* emojify ":see_no_evil:" */>}}
{{< emojify "🙉" >}} :hear_no_evil: {{</* emojify ":hear_no_evil:" */>}}
{{< emojify "🙊" >}} :speak_no_evil: {{</* emojify ":speak_no_evil:" */>}}

The Emoji cheat sheet is a useful reference for emoji shorthand codes.

{{< hint type=note >}} The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack. {{< /hint >}}

{{< highlight html "linenos=table" >}} .emoji { font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols; } {{< /highlight >}}

Expand

Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.

Usage

{{</* expand */>}}
### Markdown content
Dolor sit, sumo unique ...
{{</* /expand */>}}

It is also possible to use a custom label and symbol.

{{</* expand "Custom Label" "..." */>}}
### More markdown
Dolor sit, sumo unique ...
{{</* /expand */>}}

Example

{{< expand >}}

Markdown content

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /expand >}}

{{< expand "Custom Label" "..." >}}

More markdown

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo. {{< /expand >}}

Hint

Hint shortcode can be used as hint/alerts/notification block.

Usage

{{</* hint type=[note|tip|important|caution|warning] (icon=gblog_github) (title=GitHub) */>}}
**Markdown content**\
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
 Ornateness bland it ex enc, est yeti am bongo detract re.
{{</* /hint */>}}

Attributes

{{< propertylist name=shortcode-hints sort=name order=asc >}}

Example

{{< hint type=note >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /hint >}}

{{< hint type=tip >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /hint >}}

{{< hint type=important >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /hint >}}

{{< hint type=caution >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /hint >}}

{{< hint type=warning >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re.

Romanesque acclimates investiture. {{< /hint >}}

Example with a custom icon and title:

{{< hint type=note icon=gblog_github title=GitHub >}} Markdown content
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. {{< /hint >}}

Icon

Simple shortcode to include icons from SVG sprites outside of menus.

Usage

{{</* icon "thumbs-up" */>}}

Example

Output Code
{{< icon "thumbs-up" >}} {{</* icon "thumbs-up" */>}}
{{< icon "thumbs-down" >}} {{</* icon "thumbs-down" */>}}
{{< icon "laugh" >}} {{</* icon "laugh" */>}}
{{< icon "lemon" >}} {{</* icon "lemon" */>}}
{{< icon "moon" >}} {{</* icon "moon" */>}}

Tabs

Tabs let you organize content by context, for example installation instructions for each supported platform.

Usage

{{</* tabs "uniqueid" */>}}
{{</* tab "macOS" */>}} # macOS Content {{</* /tab */>}}
{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
{{</* /tabs */>}}

Example

{{< tabs "uniqueid" >}} {{< tab "macOS" >}}

macOS

This is tab macOS content.

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo. {{< /tab >}}

{{< tab "Linux" >}}

Linux

This is tab Linux content.

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo. {{< /tab >}}

{{< tab "Windows" >}}

Windows

This is tab Windows content.

Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent. {{< /tab >}} {{< /tabs >}}

Boxes

Boxes can be used to create a simple grid.

Usage

{{</* boxes "contact" */>}}
{{</* box size=large [title=E-Mail icon=gblog_email] */>}}mail@example.com{{</* /box */>}}
{{</* box size=large title=Matrix icon=gblog_matrix */>}}@john:example.com{{</* /box */>}}
{{</* box size=large title=XMPP icon=gblog_xmpp */>}}john@example.com{{</* /box */>}}
{{</* box size=large title=Others */>}}You can also find us on the Fediverse.{{</* /box */>}}
{{</* /boxes */>}}

Attributes

{{< propertylist name=shortcode-boxes sort=name order=asc >}}

Example

{{< boxes "contact" >}} {{< box size=large title=E-Mail icon=gblog_email >}}mail@example.com{{< /box >}} {{< box size=large title=Matrix icon=gblog_matrix >}}@john:example.com{{< /box >}} {{< box size=large title=XMPP icon=gblog_xmpp >}}john@example.com{{< /box >}} {{< box size=large title=Others >}}You can also find us on the Fediverse.{{< /box >}} {{< /boxes >}}

Mermaid

Mermaid is library for generating SVG charts and diagrams from text.

Usage

{{</* mermaid class="text-center" */>}}
sequenceDiagram
    Alice->>Bob: Hello Bob, how are you?
    alt is sick
        Bob->>Alice: Not so good :(
    else is well
        Bob->>Alice: Feeling fresh like a daisy
    end
    opt Extra response
        Bob->>Alice: Thanks for asking
    end
{{</* /mermaid */>}}

Attributes

{{< propertylist name=shortcode-mermaid sort=name order=asc >}}

Example

{{< mermaid class="text-center" >}} sequenceDiagram Alice->>Bob: Hello Bob, how are you? alt is sick Bob->>Alice: Not so good :( else is well Bob->>Alice: Feeling fresh like a daisy end opt Extra response Bob->>Alice: Thanks for asking end {{< /mermaid >}}

As an alternative to shortcodes, code blocks can be used for markdown as well.

{{< columns >}}

```mermaid
flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

<--->

flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]

{{< /columns >}}

KaTeX

KaTeX shortcode let you render math typesetting in markdown document.

Usage

{{</* katex [display] [class="text-center"] */>}}
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
{{</* /katex */>}}

Attributes

{{< propertylist name=shortcode-katex sort=name order=asc >}}

Example

{{< katex display >}} f(x) = \int_{-\infty}^\infty\hat f(\xi),e^{2 \pi i \xi x},d\xi {{< /katex >}}

KaTeX can be used inline, for example {{< katex >}}\pi(x){{< /katex >}} or used with the display parameter as above.

Progress

Usage

{{</* progress title=Eating value=65 icon=gblog_heart */>}}

Attributes

{{< propertylist name=shortcode-progress sort=name order=asc >}}

Example

{{< progress title=Eating value=65 icon=gblog_heart >}}

Properties

The property list shortcode creates a custom HTML description list that can be used to display properties or variables and general dependent information. The shortcode requires a data file in data/properties/, e.g. data/properties/demo.yaml.

Usage

{{</* propertylist name=demo (sort=name) (order=[asc|desc]) */>}}

The supported attributes can be taken from the following example:

{{< include file="/data/properties/demo.yaml" language="Yaml" options="linenos=table" >}}

Attributes

{{< propertylist name=shortcode-propertylist sort=name order=asc >}}

Example

{{< propertylist name=demo sort=name order=asc >}}