Markdown Syntax Guide

This article offers a sample of basic Markdown syntax that can be used in Hugo content files.

Basic Syntax

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Emphasis

*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_

This text will be italic

This will also be italic

This text will be bold

This will also be bold

You can combine them

Lists

Unordered

* Item 1
* Item 2
  * Item 2a
  * Item 2b

• Item 1
• Item 2
  • Item 2a
  • Item 2b

Ordered

1. Item 1
2. Item 2
3. Item 3
   1. Item 3a
   2. Item 3b

Images

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)

Links

[Hugo](https://gohugo.io)

Hugo

Blockquotes

As Newton said:

> If I have seen further it is by standing on the shoulders of Giants.

If I have seen further it is by standing on the shoulders of Giants.

Inline Code

Inline `code` has `back-ticks around` it.

Inline code has back-ticks around it.

Code Blocks

Syntax Highlighting

```go
func main() {
    fmt.Println("Hello World")
}
```

func main() {
    fmt.Println("Hello World")
}

Tables

| Syntax    | Description |
| --------- | ----------- |
| Header    | Title       |
| Paragraph | Text        |

Shortcodes

• Cards

Image Card

Unsplash Landscape

Local Image

Raw image under static directory.

Local Image

Image under assets directory, processed by Hugo.

• Callouts
  ℹ️

  Please visit GitHub to see the latest releases.

• Details

• Filetree

• Icon

• Steps

• Tabs

iframe

• qq music

• gamma

• xmind

• youtube

Diagrams

• mermaid

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

• drawio

test drawio diagram

• excalidraw

test excalidraw diagram

figure

Gallery

引入 hugo-easy-gallery 提供支持

• local image gallery use image file name as caption.

  

  

  

  

• specific image url gallery

  

  

  

References

• Markdown Syntax
• Hugo Markdown