Basic Markdown syntax
This post showcases the basic Markdown syntax you’ll see in major Markdown editors.
Some are taken from Grav, Hugo LoveIt theme documentation.
The following sections will be
📄: documentation
💡: tips
🔨: tool
1 | What you write in Markdown |
What would be rendered
Headings
1 | ## h2 Heading |
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Inline HTML
HTML tags are supported if you need a particular HTML tag or html comments.
1 | Paragraph in Markdown. |
Paragraph in Markdown.
Paragraph in Markdown.
Horizontal Rules
1 | --- |
Emphasis
Bold, italics, and strikethrough can be used either indivisually or in combination.
1 | **rendered as bold text** |
rendered as bold text
rendered as bold text
rendered as italicized text
rendered as italicized text
Strike through this text
Blockquotes
1 | > **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined. |
Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
Multiline quotes
One
Two
Lists
Unordered
1 | * Lorem ipsum dolor sit amet |
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
Ordered
💡 If you just use 1. for each number, Markdown will automatically number each item.
1 | 1. Lorem ipsum dolor sit amet |
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
Markdown Code blocks
Inline monospace
1 | `code here` |
code here
Block fenced code, with syntax highlighting
1 | ```python |
1 | print("Hey!") |
Tables
💡 See tables generator 🔨 for syntax.
1 | | Option | Description | |
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Links
1 | <https://assemble.io> |
https://assemble.io
contact@revolunet.com
Assemble
Upstage
Footnotes
💡 Footnotes are automatically numbered.
1 | This is a digital footnote[^1]. |
This is a digital footnote[1]
This is a footnote with “label”[2]
Keyboard strokes
markdown-it-kbd is needed.
1 | [[Ctrl]] + [[Alt]] + [[Delete]] |
Ctrl + Alt + Delete
Images
1 |  |
It is actually easier to use absolute paths than relative ones in Hexo.
You could attach images or documents to GitHub issues for free hosting.
MathJax rendering
See Post not found: md-math math rendering.
Emojis
See Post not found: emoji emoji.