Markdown
Toucan processes markdown files to render HTML content. These markdown files can include front matter to define additional properties that control how the content is rendered.
Markdown is a lightweight markup language used to format plain text. Here’s how to use its essential syntax.
Headings
Use # for headings. The number of # symbols determines the level:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Bold and Italics
Bold: **text** or __text__
Italic: *text* or _text_
Bold and Italic: ***text*** or ___text___
This is bold.
This is italic.
This is bold and italic.
Blockquotes
Use > to create blockquotes:
> This is a blockquote.
This is a blockquote.
Horizontal Rules
To create a horizontal rule, use three or more asterisks (***), dashes (—), or underscores (___) on a line by themselves.
***
---
___
Lists
Unordered Lists
Use ‘-’ or ‘*’ to create unordered lists:
- Item 1
- Item 2
- Subitem 2.1
- Item 1
- Item 2
- Subitem 2.1
Ordered Lists
Use numbers followed by a period to create an ordered list:
1. Item 1
2. Item 2
1. Subitem 2.1
- Item 1
- Item 2
- Subitem 2.1
Nesting
You can nest ordered and unordered lists together:
1. Ordered item
- Subitem 1
- Ordered item
- Subitem 1
Links
Use square brackets [ ] for the link text and parentheses ( ) for the URL:
Simple link
[Link Text](https://example.com)
Mail link
[Send me an email](mailto:[email protected])
Images
Basic Images
Similar to links, but with an exclamation mark ! at the beginning:
Images with Titles
Add a title in quotes for extra context:
Code Blocks
Inline Code
Wrap code in backticks:
`inline code`
Code Blocks
Use triple backticks for multi-line code:
```swift
func example() {
print("Hello, World!")
}
```