This post provides a sample of commonly used Markdown formatting.
Chalk uses the default Hugo syntax highlighting shortcode highlight
.
<!-- This is a comment -->
<div class="grid">
<h1>This is a heading</h1>
<p>
This is a paragraph text.
</p>
</div>
Headings
Chalk includes 3 headings by default:
Heading first level
Heading second level
Heading third level
## Heading first level
### Heading second level
#### Heading third level
Lists
Unordered list example:
- Unordered list item 1
- Unordered list item 2
- Unordered list item 3
- Unordered list item 4
Ordered list example:
- Ordered list item 1
- Ordered list item 1
- Ordered list item 1
- Ordered list item 1
* Unordered list item 1
* Unordered list item 2
1. Order list item 1
2. Order list item 1
Emoji support ⭐
Emoji’s can be used everywhere in 🐈 your markdown!
Add enableEmoji = true
to your config.toml file.
Quotes
A quote looks like this:
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.
> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna.
Media
Images can be added with a default <img>
tag.
If you wish that an image can be enlarged on click use the image
shortcode. You can pass 3 variables:
path
: Image to show in the blog post.path_detail
: Image to show when enlarging.alt
: Alt text for image in blog post.
{{< image path="images/sample-image.jpeg" path_detail="images/sample-image@2x.jpeg" alt="Sample image" >}}