Jekyll & Minimal Mistakes Markdown Reference
This document provides an extensive reference for Markdown and additional features supported in Jekyll and Minimal Mistakes.
1. Headings
# Heading 1 /// page title like
## Heading 2 /// Chapter headding with line
### Heading 3 /// Section heading
#### Heading 4 /// Subsection heading
##### Heading 5 /// Paragraph heading
###### Heading 6 /// inline heading
Output:
Heading 1 /// page title like
Heading 2 /// Chapter headding with line
Heading 3 /// Section heading
Heading 4 /// Subsection heading
Heading 5 /// Paragraph heading
Heading 6 /// inline heading
2. Paragraphs & Line Breaks
This is a paragraph.
This is another paragraph.
Output:
This is a paragraph.
This is another paragraph.
To force a line break, use two spaces at the end of a line or <br>.
This is a line with a break.
This is another line.
Output:
This is a line with a break.
This is another line.
3. Emphasis (Bold, Italic, Strikethrough)
*Italic* or _Italic_
**Bold** or __Bold__
***Bold and Italic*** or ___Bold and Italic___
~~Strikethrough~~
Output:
Italic or Italic
Bold or Bold
Bold and Italic or
Bold and Italic
Strikethrough
4. Lists
Unordered List:
- Item 1
- Item 2
- Sub-item 1
- Sub-item 2
- Item 3
Output:
- Item 1
- Item 2
- Sub-item 1
- Sub-item 2
- Item 3
Ordered List:
1. First item
2. Second item
1. Sub-item 1
2. Sub-item 2
3. Third item
Output:
- First item
- Second item
- Sub-item 1
- Sub-item 2
- Third item
5. Links
[Text Link](https://caia.center)
[Relative Link](/md/)
Output:
Text Link
Relative Link
6. Images
output:
Minimal Mistakes captioned images:
*This is an image caption.*
Output:
This is an image caption.
7. Blockquotes
> This is a blockquote.
>
> - Author
Output:
This is a blockquote.
- Author
8. Inline Code & Code Blocks
Inline code:
This is `inline code`.
Output:
This is inline code
Syntax-highlighted code block:
```python
def hello():
print("Hello, world!")
```
Output:
def hello():
print("Hello, world!")
Minimal Mistakes custom:
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># Sample Ruby code</span>
<span class="nb">puts</span> <span class="s2">"Hello, world!"</span></code></pre></figure>
Output:
# Sample Ruby code
puts "Hello, world!"9. Tables
| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 |
Output:
| Column 1 | Column 2 | Column 3 |
|---|---|---|
| Data 1 | Data 2 | Data 3 |
| Data 4 | Data 5 | Data 6 |
10. Footnotes
Here is a sentence with a footnote.[^1]
[^1]: This is the footnote text.
Output:
Here is a sentence with a footnote.1
“In order to finde the footnote text, please press ‘1’ ;)”
11. Alerts & Callouts (Minimal Mistakes)
> **Info:** This is an informational notice.
>
> **Warning:** This is a warning notice.
>
> **Danger:** This is a danger notice.
Output:
Info: This is an informational notice.
Warning: This is a warning notice.
Danger: This is a danger notice.
12. Tags & Taxonomy
Example front matter:
---
title: "My Blog Post"
categories: ["projects", "development"]
tags: ["jekyll", "minimal-mistakes", "markdown"]
---
Displaying tags:
<a href="/tags/markdown-minimal-mistakes-posts/">#Markdown, Minimal Mistakes, posts</a>
Output:
#Markdown, Minimal Mistakes, posts
13. Embedding Videos
<!-- Courtesy of embedresponsively.com -->
<div class="responsive-video-container">
<iframe src="https://www.youtube-nocookie.com/embed/6yDr7CWLJ8c" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen></iframe>
</div>
Output:
14. Embedding Gists
15. Math & LaTeX
$$
E = mc^2
$$
Output:
\[E = mc^2\]Inline math:
Einstein's equation: $$ E = mc^2 $$.
Output:
Einstein’s equation: \(E = mc^2\).
16. Custom Layouts (Minimal Mistakes)
layout: single # Default for blog posts
layout: splash # Large header with call-to-action
layout: home # Used for the homepage
This Markdown reference can be used as a hidden linked page for quick access while working in Jekyll and Minimal Mistakes.
