GoBlogger

Simple blogging. Single-binary deployment, easy for everyone.


Markdown Basics

Markdown rendering reference for headings, text, links, and lists with source examples.

Contents

This is part 1 of a split Markdown rendering reference for GoBlogger.

The examples show both the rendered result and the Markdown source used to create it.

Series:

  1. Text, links, and lists (this post)
  2. Blocks, code, tables, and HTML
  3. Admonitions, footnotes, and mixed formatting

Headings

Rendered:

H1 Heading

H2 Heading

H3 Heading

H4 Heading

H5 Heading
H6 Heading

Setext heading level 1

Setext heading level 2

Source:

# H1 Heading
## H2 Heading
### H3 Heading
#### H4 Heading
##### H5 Heading
###### H6 Heading

Setext heading level 1
======================

Setext heading level 2
----------------------

Paragraphs, Breaks, and Escapes

Rendered:

Paragraph one with normal wrapping.

Paragraph two with a forced line break at the end of this line.
This should appear on a new line.

Escaped punctuation: *literal asterisks*, _literal underscore_, #literal hash_like.

Source:

Paragraph one with normal wrapping.

Paragraph two with a forced line break at the end of this line.  
This should appear on a new line.

Escaped punctuation: \*literal asterisks\*, \_literal underscore\_, \#literal hash\_like.

Emphasis and Inline Text

Rendered:

Plain text with bold, italic, bold italic, strikethrough, and inline code.

Mixing emphasis inside links: Bold link to docs.

Inline HTML entities: less-than <, ampersand &, and © symbol.

Source:

Plain text with **bold**, *italic*, ***bold italic***, ~~strikethrough~~, and `inline code`.

Mixing emphasis inside links: [**Bold link** to docs](https://example.com/docs).

Inline HTML entities: less-than `<`, ampersand `&`, and © symbol.

Rendered:

Inline link: GoBlogger README

Autolink (GFM/linkify): https://example.com/docs/getting-started

Mail autolink: contact@example.com

Reference-style link: project site

Source:

Inline link: [GoBlogger README](https://example.com/readme)

Autolink (GFM/linkify): https://example.com/docs/getting-started

Mail autolink: contact@example.com

Reference-style link: [project site][project-ref]

[project-ref]: https://example.com/project

Lists

Rendered:

Unordered:

  • Item one
  • Item two
    • Nested item two-a
    • Nested item two-b
  • Item three

Ordered:

  1. Step one
  2. Step two
  3. Step three
    1. Nested step
    2. Another nested step

Task list (GFM):

  • Front matter parsed
  • Markdown rendered
  • Add project-specific snippets later

Source:

Unordered:

- Item one
- Item two
  - Nested item two-a
  - Nested item two-b
- Item three

Ordered:

1. Step one
2. Step two
3. Step three
   1. Nested step
   2. Another nested step

Task list (GFM):

- [x] Front matter parsed
- [x] Markdown rendered
- [ ] Add project-specific snippets later

Next: Part 2: Blocks, code, tables, and HTML