Liveblog47

This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.

# Headings

The following HTML <h2>—<h6> elements represent 5 levels of section headings. <h2> is the highest section level while <h6> is the lowest.

# H2

You should using ## H2 as your section title, since the file title is # H1

If you use # H1 as your section title, you will get a warning from linter:

MD025/single-title/single-h1: Multiple top-level headings in the same document

## H3

# Paragraph

Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga.

Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.

# Blockquotes

The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.

## Blockquote without attribution

Tiam, ad mint andaepu dandae nostion secatur sequo quae.

Note that you can use Markdown syntax within a blockquote.

## Blockquote with attribution

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike¹

# Tables

Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box.

Name	Age
Bob	27
Alice	23

## Inline Markdown within tables

Inline	Markdown	In	Table
italics	bold	~~strikethrough~~	`code`

# Code Blocks

## Code block with backticks and showing highlighted lines

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

## Code block indented with four spaces

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

## Code block with Hugo’s internal highlight shortcode

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

# List Types

## Ordered List

First item
Second item
Third item

## Unordered List

List item
Another item
And another item

## Nested list

Item

First Sub-item
Second Sub-item

# Other Elements — abbr, sub, sup, kbd, mark

GIF is a bitmap image format.

H₂O

Xⁿ + Yⁿ = Zⁿ

Press CTRL+ALT+Delete to end the session.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎

Demo - Support for Diagrams

me@junyi.dev (Junyi) — Mon, 06 May 2024 00:00:00 +0000

Feel free to switch between the light and dark themes to see how the diagram adapts its colors accordingly.

# Mermaid Diagrams

gantt
    title A Gantt Diagram
    dateFormat YYYY-MM-DD
    section Section
        A task          :a1, 2014-01-01, 30d
        Another task    :after a1, 20d
    section Another
        Task in Another :2014-01-12, 12d
        another task    :24d

Get more examples at About Mermaid

gitGraph:
    commit "Ashish"
    branch newbranch
    checkout newbranch
    commit id:"1111"
    commit tag:"test"
    checkout main
    commit type: HIGHLIGHT
    commit
    merge newbranch
    commit
    branch b2
    commit

stateDiagram
    [*] --> Still
    Still --> [*]

    Still --> Moving
    Moving --> Still
    Moving --> Crash
    Crash --> [*]

sankey-beta

Pumped heat,"Heating and cooling, ""homes""",193.026
Pumped heat,"Heating and cooling, ""commercial""",70.672

sequenceDiagram
    loop Daily query
        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
    end

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!

# GoAT

Demo - Social Icons

me@junyi.dev (Junyi) — Sun, 05 May 2024 00:00:00 +0000

To use an icon, simply copy its shortcode and paste it into your content where you want the icon to appear. The shortcode must be enclosed in {{< >}}.

Here is a list of available icons, their shortcodes, and what they look like when rendered:

name	shortcode	icon
4chan	`{{< icon "4chan" >}}`
leetcode	`{{< icon "leetcode" >}}`
qq	`{{< icon "qq" >}}`
spotify	`{{< icon "spotify" >}}`
tinder	`{{< icon "tinder" >}}`
youtube	`{{< icon "youtube" >}}`
docs	`{{< icon "docs" >}}`
linkedin	`{{< icon "linkedin" >}}`
reddit	`{{< icon "reddit" >}}`
steam	`{{< icon "steam" >}}`
tumblr	`{{< icon "tumblr" >}}`
zhihu	`{{< icon "zhihu" >}}`
email	`{{< icon "email" >}}`
mastodon	`{{< icon "mastodon" >}}`
rss	`{{< icon "rss" >}}`
teams	`{{< icon "teams" >}}`
twitch	`{{< icon "twitch" >}}`
facebook	`{{< icon "facebook" >}}`
medium	`{{< icon "medium" >}}`
skype	`{{< icon "skype" >}}`
telegram	`{{< icon "telegram" >}}`
twitter	`{{< icon "twitter" >}}`
github	`{{< icon "github" >}}`
netease	`{{< icon "netease-music" >}}`
slack	`{{< icon "slack" >}}`
theme	`{{< icon "theme-dark" >}}`
vk	`{{< icon "vk" >}}`
gitlab	`{{< icon "gitlab" >}}`
notion	`{{< icon "notion" >}}`
snapchat	`{{< icon "snapchat" >}}`
theme	`{{< icon "theme-light" >}}`
weibo	`{{< icon "weibo" >}}`
instagram	`{{< icon "instagram" >}}`
patreon	`{{< icon "patreon" >}}`
soundcloud	`{{< icon "soundcloud" >}}`
tiktok	`{{< icon "tiktok" >}}`
x	`{{< icon "x" >}}`

Demo - Support for code, pre, kbd, mark

me@junyi.dev (Junyi) — Tue, 30 Apr 2024 00:00:00 +0000

# Individual support for code, pre, kbd, mark

code

pre

CRTL + K + B + D

Feel free to switch between the light and dark themes to see the rendering differences.

## Support for <code> tag

Direct Code

A verrrrrryyyyy llloooonnnggg coooodeeee

code is here

multiline
code
here

// ```typescript
interface User {
  id: number
  firstName: string
  lastName: string
  role: string
}

1// ```typescript {linenos=inline}
2function updateUser(id: number, update: Partial<User>) {
3  const user = getUser(id)
4  const newUser = { ...user, ...update }
5  saveUser(id, newUser)
6}

// ```typescript {linenos=true}
function updateUser(id: number, update: Partial<User>) {
  const user = getUser(id)
  const newUser = { ...user, ...update }
  saveUser(id, newUser)
}

## Support for <pre> tag

pre text

pre text

pre text

## Support for <kbd> tag

Press CTRL + C to copy text (Windows).

Press CMD + C to copy text (Mac OS).

Press CTRL+ALT+Delete to end the session.

## Support for <mark> tag

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

## Support for <kbd> in <pre>

This is a KBD inside a pre.

## Support for <kbd> in <code> (❌ Should not be used)

This is a KBD inside a code.

## Support for <code> in <pre> (❌ Should not be used)

This is a CODE inside a pre.

## Support for <code> in <kbd> (❌ Should not be used)

This is a CODE inside a kbd.

## Support for <pre> in <kbd> (❌ Should not be used)

This is a

PRE

inside a kbd.

## Support for <pre> in <code> (❌ Should not be used)

This is a

PRE

inside a code.

## Support for <mark> in <kbd>

This is a MARK inside a kbd.

## Support for <mark> in <code>

This is a MARK inside a code.

## Support for <mark> in <pre>

This is a MARK inside a pre.

Demo - Multiline Codes

me@junyi.dev (Junyi) — Tue, 23 Apr 2024 00:00:00 +0000

int main() {
    int a = 1;
    if (a == 999)
        // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

# Truth Table

Item	Line Numbers	Highlight Lines	Anchor Lines	Wide CodeBlock Scroll	Supported
Full Feature Support	ture	true	true	✅	✅
	table	true	true	✅	✅
	table	true	false	✅	✅
	inline			✅	✅
	ture	true	false	✅	✅
	ture	false	false	✅	✅
	false	true	/	✅	✅
Basic Support	false	false	/	✅	✅

Note: Anubis2 does not support hl_inline=true

# Line Numbers, Highlight Lines

## Line Number (table) and Highlight Lines

linenos=table will give copy-and-paste friendly code blocks.

```c {linenos=table, hl_lines=[1,"3-4",8], linenostart=199}
// codes ...
```

int main() {
    int a = 1;
    if (a == 999)
        // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

## Line Number (true) and Highlight Lines

```c {linenos=true, hl_lines=[1,"3-4",8], linenostart=1}
// codes ...
```

int main() {
    int a = 1;
    if (a == 999)
        // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

## Line Number (inline) and Highlight Lines

```c {linenos=inline, hl_lines=[1,"3-4",8], linenostart=1}
// codes ...
```

1int main() {
2    int a = 1;
3    if (a == 999)
4                // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
5        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
6    }
7    return 0;
8}

## Line Number (false) and Highlight Lines

linenos=false will turn off line numbers if it’s configured to be on in site configuration.

```c {linenos=false, hl_lines=[1,"3-4",8]}
// codes ...
```

int main() {
    int a = 1;
    if (a == 999)
                // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

# Anchor, Inline, Shortcode

## Line Number (table) and Highlight Lines and Anchor

Now you can click on the line number to get a link to that line.

```c {linenos=table, hl_lines=[1,"3-4",8], linenostart=199, anchorlinenos=true}
// codes ...
```

int main() {
    int a = 1;
    if (a == 999)
        // This is a very long comment to test the `overflow` attribute defined in CSS. The `overflow` property in CSS deals with the content when it overflows the block-level container. It can take the following values: `visible` (default), `hidden`, `scroll`, `auto`, and `clip`.
        // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content.
    }
    return 0;
}

## Highlight Inline are not supported by Anubis2 ❌

```c {linenos=true,hl_lines=[1,3,5], hl_inline=true}
// codes ...
```

1 2 3 4 5 6 7 int main() { int a = 1; if (a == 999) // If `visible` is specified, the content is not clipped and can render outside the container. If `hidden` is specified, the content is clipped and the rest of the content will be invisible. If `scroll` is specified, the browser should provide a scrolling mechanism for the user to access the clipped content. } return 0; }

About

me@junyi.dev (Junyi) — Tue, 09 Apr 2024 00:00:00 +0000

Anubis2 is another simple minimalist theme for Hugo blog engine.

Written in Go, Hugo is an open source static site generator available under the Apache License 2.0. Hugo supports TOML, YAML and JSON data file types, Markdown and HTML content files and uses shortcodes to add rich content. Other notable features are taxonomies, multilingual mode, image processing, custom output formats, HTML/CSS/JS minification and support for Sass SCSS workflows.

Hugo makes use of a variety of open source projects including:

Hugo is ideal for blogs, corporate websites, creative portfolios, online magazines, single page applications or even a website with thousands of pages.

Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.

Websites built with Hugo are extremely fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.

Learn more and contribute on GitHub.

Advanced Style

me@junyi.dev (Junyi) — Tue, 09 Apr 2024 00:00:00 +0000

There are examples of how to use custom global-wise style or page-wise style.

The custom .css .scss .sass file should be placed in assets/ folder. (instead of static/)

This page is affected by assets/css/custom1.scss and assets/css/custom2.css and advanced-style/style.css

advanced-style/style.css affects only the current page.

<style>
  @import 'style.css';
</style>

assets/css/custom1.scss and assets/css/custom2.scss will have global effect.

// assets/css/custom2.css
.anubis-custom-style {
    background-color: pink;
    color: black;
    padding: 1em;
    border-radius: 0.3em;
    border: 1px solid black;
}

// assets/css/foundation/_vars.scss
$font-stack: Helvetica, sans-serif;
$primary-color: rgb(255, 255, 168);
$background-color: rgb(85, 85, 85);

// assets/css/custom1.scss
@import 'foundation/vars';

junyi {
    display: block;
    font: 100% $font-stack;
    color: $primary-color;
    background-color: $background-color;
    margin-top: 1em;
}

Rich Content

me@junyi.dev (Junyi) — Sun, 10 Mar 2019 00:00:00 +0000

Hugo ships with several Built-in Shortcodes for rich content, along with a Privacy Config and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.

# YouTube Privacy Enhanced Shortcode

# Twitter Simple Shortcode

“In addition to being more logical, asymmetry has the advantage that its complete appearance is far more optically effective than symmetry.”
— Jan Tschichold pic.twitter.com/gcv7SrhvJb
— Design Reviewed | Graphic Design History (@DesignReviewed) January 17, 2019

# Vimeo Simple Shortcode

Placeholder Text

me@junyi.dev (Junyi) — Sat, 09 Mar 2019 00:00:00 +0000

Lorem est tota propiore conpellat pectoribus de pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.

Exierant elisi ambit vivere dedere
Duce pollice
Eris modo
Spargitque ferrea quos palude

Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.

Comas hunc haec pietate fetum procerum dixit
Post torum vates letum Tiresia
Flumen querellas
Arcanaque montibus omnes
Quidem et

# Vagus elidunt

The Van de Graaf Canon

# Mane refeci capiebant unda mulcebat

Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. Faces illo pepulere tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.

Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.

Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel mitis temploque vocatus, inque alis, oculos nomen non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides parte.

Math Typesetting

me@junyi.dev (Junyi) — Fri, 08 Mar 2019 00:00:00 +0000

Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries.

To enable MathJax on a page basis include the parameter math: true in content files.

# Examples

Inline math: $$ \varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887… $$

Block math:

$$ \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } $$

Emoji Support

me@junyi.dev (Junyi) — Tue, 05 Mar 2019 00:00:00 +0000

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; e.g.

🙈 :see_no_evil: 🙉 :hear_no_evil: 🙊 :speak_no_evil:

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

N.B. 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; e.g.

.emoji {
font-family: Apple Color Emoji,Segoe UI Emoji,NotoColorEmoji,Segoe UI Symbol,Android Emoji,EmojiSymbols;
}