Markdown Syntax

Writing clear and well-structured content is key to a great website. This guide provides examples of common Markdown elements as rendered by the Goyo theme and offers some tips for effective writing.

Headings

Use headings to structure your content logically. Start with an <h1> (which is usually the page title, automatically handled) and use <h2> through <h6> sequentially.

# This is an H1 (Usually the page title)
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6

Renders as:

This is an H2

This is an H3

This is an H4

This is an H5
This is an H6

Paragraphs and Line Breaks

Write paragraphs as normal text. To create a new paragraph, leave a blank line. For a soft line break (a <br>), end a line with two or more spaces.

This is a paragraph.
It has multiple lines.

This is a new paragraph.

This line has a soft break.
This line has a soft break.
This line is below it.

Renders as:

This is a paragraph. It has multiple lines.

This is a new paragraph.

This line has a soft break. This line is below it.

Emphasis

You can make text bold or italic.

*Italic text* or _Italic text_
**Bold text** or __Bold text__
***Bold and Italic*** or ___Bold and Italic___
~~Strikethrough text~~

Renders as:

Italic text or Italic text Bold text or Bold text Bold and Italic or Bold and Italic Strikethrough text

Lists

Unordered Lists

Use asterisks (*), pluses (+), or hyphens (-) for unordered lists.

* Item 1
* Item 2
  * Sub-item 2.1
  * Sub-item 2.2
- Another item

Renders as:

  • Item 1
  • Item 2
    • Sub-item 2.1
    • Sub-item 2.2
  • Another item

Ordered Lists

Use numbers followed by periods.

1. First item
2. Second item
   1. Sub-item 2.1
   2. Sub-item 2.2
3. Third item

Renders as:

  1. First item
  2. Second item
    1. Sub-item 2.1
    2. Sub-item 2.2
  3. Third item

Task Lists (GitHub Flavored Markdown)

- [x] Completed task
- [ ] Incomplete task

Renders as:

  • Completed task
  • Incomplete task

Create inline links or reference-style links.

[This is an inline link to Zola's website](https://www.getzola.org/)

[This is a reference-style link][zola]

[zola]: https://www.getzola.org/ "Zola's Homepage"

Renders as:

This is an inline link to Zola's website

This is a reference-style link

Images

Image syntax is similar to links but prefixed with an exclamation mark.

![Alt text for the image](https://placehold.co/600x100/png?text=Goyo+Placeholder)

Renders as:

Alt text for the image

(Note: The Goyo theme ensures images are responsive.)

Blockquotes

Use > to create blockquotes.

> This is a blockquote.
> It can span multiple lines.
>
> > Nested blockquote.

Renders as:

This is a blockquote. It can span multiple lines.

Nested blockquote.

Code

Inline Code

Wrap code with single backticks.

Use the `zola build` command to build your site.

Renders as:

Use the zola build command to build your site.

Code Blocks (Fenced)

Use triple backticks and specify the language for syntax highlighting.

```python
def hello():
  print("Hello, Goyo!")
```

```javascript
console.log("Hello, Goyo!");
```

Renders as:

def hello():
  print("Hello, Goyo!")
console.log("Hello, Goyo!");

Horizontal Rule

Use three or more hyphens, asterisks, or underscores on a line by themselves.

---
***
___

Renders as:


Tables

Create tables using pipes (|) and hyphens (-).

| Header 1 | Header 2 | Header 3 |
| :------- | :------: | -------: |
| Align L  | Center A | Align R  |
| Cell 2   | Cell 3   | Cell 4   |
| Cell 5   | Cell 6   | Cell 7   |

Renders as:

Header 1Header 2Header 3
Align LCenter AAlign R
Cell 2Cell 3Cell 4
Cell 5Cell 6Cell 7

Footnotes

Create footnotes using [^label] and [^label]: note content.

This is some text with a footnote.[^1]

And another one.[^another]

[^1]: This is the first footnote.
[^another]: This is another footnote. It can contain **Markdown** as well.

Renders as:

This is some text with a footnote.1

And another one.2

1

This is the first footnote.

2

This is another footnote. It can contain Markdown as well.