- /
-
- Creating content /
- Markdown
Markdown
All available markdown tags into a single page with examples
Last modified 2025-05-23
ITADS
Table of content
- Paragraph and carriage return
- h1 heading
- h2 heading
- h3 heading
- h4 heading
- h5 heading
- h6 heading
- Emphasis
- Unordered lists
- Ordered lists
- Mixed lists
- Brackets links
- Internal links
- Reference links
- Links with title
- Images
- Local images
- Remote images
- Reference images
- Inline code
- Syntax highlighting
- Tables
- Blockquotes
- Horizontal rule
This page illustrates renders of all different markdown tags. Learn more about markdown.
Paragraph and carriage return
At glance: Double carriage return renders a paragraph, single carriage return renders ... a simple carriage return. Here is an example.
First paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
Second paragraph because of double carriage return. Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
Paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing. Single carriage return done, still the same paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
First paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
Second paragraph because of double carriage return. Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
Paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
Single carriage return done, still the same paragraph: Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
h1 heading
h2 heading
h3 heading
h4 heading
h5 heading
h6 heading
# h1 heading
## h2 heading
### h3 heading
#### h4 heading
##### h5 heading
###### h6 heading
Emphasis
Lightest emphasis is set with single asterisks or underscores.
Strong emphasis is set with double asterisks or underscores.
Strikethrough using two tildes. this text is scratched.
Lightest emphasis is set with single *asterisks* or _underscores_.
Strong emphasis is set with double **asterisks** or __underscores__.
Strikethrough using two tildes. ~~this text is scratched.~~
Unordered lists
To create unordered lists, use asterisks *
or +
or -
followed by space. To create unordered lists into unordered list items, indent your text just like the following example.
- I am the first item of the unordered list
- I am the second item and i contain another unordered list
- Small item
- Another unordered list into an item
- Sub sub item
- Another sub sub item.
- A sub sub item containing multiple paragraphs. Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
- Penultimate item.
- And this is the latest item.
- Sub Or pluses
- Sub And another item.
- Sub And another item.
- Voluptua vero consetetur sadipscing.
- Dolores justo sadipscing gubergren magna.
- Justo dolore vero stet ea dolores lorem.
* I am the first item of the unordered list
* I am the second item and i contain another unordered list
- Small item
- Another unordered list into an item
+ Sub sub item
+ Another sub sub item.
+ A sub sub item containing multiple paragraphs. Dolores justo sadipscing gubergren magna elitr consetetur sea tempor, elitr dolore vero stet ea dolores lorem. Voluptua vero consetetur sadipscing.
+ Penultimate item.
+ And this is the latest item.
- Sub Or pluses
- Sub And another item.
- Sub And another item.
* Voluptua vero consetetur sadipscing.
* Dolores justo sadipscing gubergren magna.
* Justo dolore vero stet ea dolores lorem.
Ordered lists
LibDoc supports automatic nestable bullet numbering. Incremental writing is optional. You can set 1.
on every item. Here is an example taken from Geologic time scale.
- Hadean Eon (4567–4030 Ma)
- Chaotian Era/Erathem (4567–4404 Ma) – the name alluding both to the mythological Chaos and the chaotic phase of planet formation.
- Jack Hillsian or Zirconian Era/Erathem (4404–4030 Ma) – both names allude to the Jack Hills Greenstone Belt which provided the oldest mineral grains on Earth, zircons.
- Archean Eon/Eonothem (4030–2420 Ma)
- Paleoarchean Era/Erathem (4030–3490 Ma)
- Acastan Period/System (4030–3810 Ma) – named after the Acasta Gneiss, one of the oldest preserved pieces of continental crust.
- Isuan Period/System (3810–3490 Ma) – named after the Isua Greenstone Belt.
- Mesoarchean Era/Erathem (3490–2780 Ma)
- Vaalbaran Period/System (3490–3020 Ma) – based on the names of the Kaapvaal (Southern Africa) and Pilbara (Western Australia) cratons, to reflect the growth of stable continental nuclei or proto-cratonic kernels.
- Pongolan Period/System (3020–2780 Ma) – named after the Pongola Supergroup, in reference to the well preserved evidence of terrestrial microbial communities in those rocks.
- Neoarchean Era/Erathem (2780–2420 Ma)
- Methanian Period/System (2780–2630 Ma) – named for the inferred predominance of methanotrophic prokaryotes
- Siderian Period/System (2630–2420 Ma) – named for the voluminous banded iron formations formed within its duration.
- Proterozoic Eon/Eonothem (2420–538.8 Ma)
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Oxygenian Period/System (2420–2250 Ma) – named for displaying the first evidence for a global oxidising atmosphere.
- Jatulian or Eukaryian Period/System (2250–2060 Ma) – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Mesoproterozoic Era/Erathem (1780–850 Ma)
- Rodinian Period/System (1780–850 Ma) – named after the supercontinent Rodinia, stable environment.
1. Hadean Eon (4567–4030 Ma)
1. Chaotian Era/Erathem (4567–4404 Ma) – the name alluding both to the mythological Chaos and the chaotic phase of planet formation.
1. Jack Hillsian or Zirconian Era/Erathem (4404–4030 Ma) – both names allude to the Jack Hills Greenstone Belt which provided the oldest mineral grains on Earth, zircons.
1. Archean Eon/Eonothem (4030–2420 Ma)
1. Paleoarchean Era/Erathem (4030–3490 Ma)
1. Acastan Period/System (4030–3810 Ma) – named after the Acasta Gneiss, one of the oldest preserved pieces of continental crust.
1. Isuan Period/System (3810–3490 Ma) – named after the Isua Greenstone Belt.
1. Mesoarchean Era/Erathem (3490–2780 Ma)
1. Vaalbaran Period/System (3490–3020 Ma) – based on the names of the Kaapvaal (Southern Africa) and Pilbara (Western Australia) cratons, to reflect the growth of stable continental nuclei or proto-cratonic kernels.
1. Pongolan Period/System (3020–2780 Ma) – named after the Pongola Supergroup, in reference to the well preserved evidence of terrestrial microbial communities in those rocks.
1. Neoarchean Era/Erathem (2780–2420 Ma)
1. Methanian Period/System (2780–2630 Ma) – named for the inferred predominance of methanotrophic prokaryotes
1. Siderian Period/System (2630–2420 Ma) – named for the voluminous banded iron formations formed within its duration.
1. Proterozoic Eon/Eonothem (2420–538.8 Ma)
1. Paleoproterozoic Era/Erathem (2420–1780 Ma)
1. Oxygenian Period/System (2420–2250 Ma) – named for displaying the first evidence for a global oxidising atmosphere.
1. Jatulian or Eukaryian Period/System (2250–2060 Ma) – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
1. Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
1. Mesoproterozoic Era/Erathem (1780–850 Ma)
1. Rodinian Period/System (1780–850 Ma) – named after the supercontinent Rodinia, stable environment.
Below is an example mixing other markdown tags
- Hadean Eon (4567–4030 Ma)
- Chaotian Era/Erathem (4567–4404 Ma) – the name alluding both to the mythological Chaos and the chaotic phase of planet formation.
- Jack Hillsian or Zirconian Era/Erathem (4404–4030 Ma) – both names allude to the Jack Hills Greenstone Belt which provided the oldest mineral grains on Earth, zircons.
- Archean Eon/Eonothem (4030–2420 Ma)
- Paleoarchean Era/Erathem (4030–3490 Ma)
- Acastan Period/System (4030–3810 Ma) – named after the Acasta Gneiss, one of the oldest preserved pieces of continental crust.
- Isuan Period/System (3810–3490 Ma) – named after the Isua Greenstone Belt.
- Mesoarchean Era/Erathem (3490–2780 Ma)
- Vaalbaran Period/System (3490–3020 Ma) – based on the names of the Kaapvaal (Southern Africa) and Pilbara (Western Australia) cratons, to reflect the growth of stable continental nuclei or proto-cratonic kernels.
- Pongolan Period/System (3020–2780 Ma) – named after the Pongola Supergroup, in reference to the well preserved evidence of terrestrial microbial communities in those rocks.
- Neoarchean Era/Erathem (2780–2420 Ma)
- Methanian Period/System (2780–2630 Ma) – named for the inferred predominance of methanotrophic prokaryotes
- Siderian Period/System (2630–2420 Ma) – named for the voluminous banded iron formations formed within its duration.
- Paleoarchean Era/Erathem (4030–3490 Ma)
- Proterozoic Eon/Eonothem (2420–538.8 Ma)
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Oxygenian Period/System (2420–2250 Ma) – named for displaying the first evidence for a global oxidising atmosphere.
- Jatulian or Eukaryian Period/System (2250–2060 Ma) – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Mesoproterozoic Era/Erathem (1780–850 Ma)
- Rodinian Period/System (1780–850 Ma) – named after the supercontinent Rodinia, stable environment.
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
1. **Hadean Eon (4567–4030 Ma)**
1. *Chaotian Era/Erathem (4567–4404 Ma)* – the name alluding both to the mythological Chaos and the chaotic phase of planet formation.
1. *Jack Hillsian or Zirconian Era/Erathem (4404–4030 Ma)* – both names allude to the Jack Hills Greenstone Belt which provided the oldest mineral grains on Earth, zircons.
1. **Archean Eon/Eonothem (4030–2420 Ma)**
1. *Paleoarchean Era/Erathem (4030–3490 Ma)*
1. *Acastan Period/System (4030–3810 Ma)* – named after the Acasta Gneiss, one of the oldest preserved pieces of continental crust.
1. *Isuan Period/System (3810–3490 Ma)* – named after the Isua Greenstone Belt.
1. *Mesoarchean Era/Erathem (3490–2780 Ma)*
1. *Vaalbaran Period/System (3490–3020 Ma)* – based on the names of the Kaapvaal (Southern Africa) and Pilbara (Western Australia) cratons, to reflect the growth of stable continental nuclei or proto-cratonic kernels.
1. *Pongolan Period/System (3020–2780 Ma)* – named after the Pongola Supergroup, in reference to the well preserved evidence of terrestrial microbial communities in those rocks.
1. *Neoarchean Era/Erathem (2780–2420 Ma)*
1. *Methanian Period/System (2780–2630 Ma)* – named for the inferred predominance of methanotrophic prokaryotes
1. *Siderian Period/System (2630–2420 Ma)* – named for the voluminous banded iron formations formed within its duration.
1. **Proterozoic Eon/Eonothem (2420–538.8 Ma)**
1. *Paleoproterozoic Era/Erathem (2420–1780 Ma)*
1. *Oxygenian Period/System (2420–2250 Ma)* – named for displaying the first evidence for a global oxidising atmosphere.
1. *Jatulian or Eukaryian Period/System (2250–2060 Ma)* – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
1. *Columbian Period/System (2060–1780 Ma)* – named after the supercontinent Columbia.
1. *Mesoproterozoic Era/Erathem (1780–850 Ma)*
1. *Rodinian Period/System (1780–850 Ma)* – named after the supercontinent Rodinia, stable environment.
Mixed lists
Following examples contain more complex HTML structure combining ordered lists and unordered list with multiple tags inside.
Example of an ordered list containing unordered lists.
- Proterozoic Eon/Eonothem (2420–538.8 Ma)
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Oxygenian Period/System (2420–2250 Ma) named for displaying the first evidence for a global oxidising atmosphere.
- Jatulian or Eukaryian Period/System (2250–2060 Ma) – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Oxygenian Period/System (2420–2250 Ma) - named for displaying the first evidence for a global oxidising atmosphere.
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Mesoproterozoic Era/Erathem (1780–850 Ma)
- Rodinian Period/System (1780–850 Ma) – named after the supercontinent Rodinia, stable environment.
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Hadean Eon (4567–4030 Ma)
- Archean Eon/Eonothem (4030–2420 Ma)
- Proterozoic Eon/Eonothem (2420–538.8 Ma)
- Oxygenian Period/System (2420–2250 Ma) – named for displaying the first evidence for a global oxidising atmosphere.
Example of an unordered list containing ordered lists with multiple tags types.
- Proterozoic Eon/Eonothem (2420–538.8 Ma)
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Oxygenian Period/System (2420–2250 Ma) – named for displaying the first evidence for a global oxidising atmosphere.
- Jatulian or Eukaryian Period/System (2250–2060 Ma) – names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.
- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
- Paleoproterozoic Era/Erathem (2420–1780 Ma)
- Mesoproterozoic Era/Erathem (1780–850 Ma)
– names are respectively for the Lomagundi–Jatuli δ13C isotopic excursion event spanning its duration, and for the (proposed) first fossil appearance of eukaryotes.- Columbian Period/System (2060–1780 Ma) – named after the supercontinent Columbia.
Example of an ordered list containing unordered lists.
- Ordered One
- Unordered First
- Unordered Second
- Ordered One
- Unordered Second
- Unordered Third
- Unordered Fourth
- Unordered Third
- Ordered Second
- Unordered One
- Unordered Two
- Unordered Three
Brackets links
The most simple way to create a link.
https://github.com/ita-design-system/eleventy-libdoc
<https://github.com/ita-design-system/eleventy-libdoc>
Internal links
Easily create links between your project pages. Eleventy allows to create dynamic links, you set the path to the source file and the link URL is automatically rendered.
permalink
must be set into the destination page. If permalink changes on destination page, internal links pointing to this page change accordingly.
Bring me to the page ./markdown.md
[Bring me to the page ./markdown.md](/content/creating-content/markdown.md)
Links URL to pages that does not set permalink
don’t change automatically but works fine.
Bring me to the page ./markdown.md
[Bring me to the page ./markdown.md](/creating-content/markdown/)
Reference links
Reference links allows to assign text shortcuts to URL and are useful when this URL is used multiple times. Reference links are case insensitive. Example:
I am a paragraph that contains multiple links with the same URL. Permalinks are set at the beginning of every page into the front matter The Geologic Time Scale or geological time scale (GTS) is a representation of time based on the rock record of Earth.
I am a paragraph that contains [multiple links][1] with the same [URL][1].
[Permalinks][2] are set at the beginning of every page into the [front matter][2]
The [Geologic Time Scale][Geologic Time Scale] or geological time scale
([GTS][geologic time scale]) is a representation of time based on the rock record of Earth.
[1]: https://en.wikipedia.org/wiki/URL
[2]: /front-matter/
[geologic time scale]: https://en.wikipedia.org/wiki/Geologic_time_scale
Note that dynamic links to file input path don’t work on reference links.
[1]: /content/front-matter/index.md
Does not work.
Links with title
Optionnaly, you can add a title attribute to your markdown links, adding a space and a text between quotes after link URL.
[Dynamic link to front matter](/content/front-matter/index.md "Go to front matter")
Images
To optimize page performances and bandwidth, raster images like PNG, JPEG, GIF are transcoded into AVIF and WEBP format through Eleventy Image Plugin. In addition, to support responsiveness, every raster image is transcoded into multiple files with different widths to fit target devices.
Vector images are used as is.
Local images
Here is a simple case with a raster image

Here is a simple case with a vector image

Example of an image with a dynamic link:
Optionally add a title attribute:
Example of an image with a dynamic link:
[](/content/creating-content/markdown.md#images)
Optionally add a title attribute:
[](/content/creating-content/markdown.md#images "Go to Markdown page section Images")
Here is an example of a markdown link including a raster image with its natural width smaller than main content width
Please note that, awaiting enhancement, raster images smaller than main content width do not render properly on high density displays like Retina.
Here is an example of a markdown link including a vector image with its natural width smaller than main content width
Remote images
Remote images are processed just like local images through Eleventy Image Plugin.
A WEBP remote image:
A remote SVG logo:
A WEBP remote image:

A remote SVG logo:

Reference images
Just like reference links, you can assign text shortcuts to absolute or relative image URL. This avoids repeating same URL multiple times. Here is an example below.
![alt text][pierra-menta]
[pierra-menta]: /assets/images/pierra-menta.jpg "Pierra Menta"
Inline code
To display very short length of code
, just use the **following** # syntax
.
To display very short length of `code`, just `use the **following** # syntax`.
Syntax highlighting
You can highlight code based on your Highlight JS configuration.
- Enter three back-ticks
```
followed by the language alias - Enter your code to highlight
- End with the same
```
into a new line.
Example of syntax highlighting with HTML
<h1>Hello World!</h1>
<p>This is a <a href="/link/">link</a>.</p>
Markdown code
```html
<h1>Hello World!</h1>
<p>This is a <a href="/link/">link</a>.</p>
```
Example of syntax highlighting with Javascript
const m = "JavaScript syntax highlighting";
alert(m);
Markdown code
```javascript
const m = "JavaScript syntax highlighting";
alert(m);
```
Example of syntax highlighting with Liquid. Encapsulate code into raw ... endraw
raw paired shortcodes.
{% assign filePath = "." | append: path %}
{% sandboxFile path, title %}{% include filePath %}{% endsandboxFile %}
Markdown code
```liquid
{% assign filePath = "." | append: path %}
{% sandboxFile path, title %}{% include filePath %}{% endsandboxFile %}
```
Example of syntax highlighting with unspecified code
No language specified may render unwanted result, please specify.
```
No language specified may render unwanted result, please specify.
```
Tables
Table markdown was made by Github Flavoured Markdown as an extension of the Markdown specifications.
Tables are responsive and with horizontal scroll enabled if its content is wider than the max width of the main content wrapper.
First column | Second | Third |
---|---|---|
col 3 is | right-aligned | 1600 |
col 2 is | centered | 12 |
Alternate lines | are neat | 1 |
Year | Film | Director | Composer |
---|---|---|---|
2001 | Harry Potter and the Philosopher's Stone | Chris Columbus | John Williams |
2002 | Harry Potter and the Chamber of Secrets | Chris Columbus | John Williams |
2004 | Harry Potter and the Prisoner of Azkaban | Alfonso Cuarón | John Williams |
2005 | Harry Potter and the Goblet of Fire | Mike Newell | Patrick Doyle |
2007 | Harry Potter and the Order of the Phoenix | David Yates | Nicholas Hooper |
2009 | Harry Potter and the Half-Blood Prince | David Yates | Nicholas Hooper |
2010 | Harry Potter and the Deathly Hallows – Part 1 | David Yates | Alexandre Desplat |
2011 | Harry Potter and the Deathly Hallows – Part 2 | David Yates | Alexandre Desplat |
There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown inside table cells.
Markdown | Less | Pretty |
---|---|---|
Still | renders |
nicely |
1 | 2 | 3 |
| First column | Second | Third |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | 1600 |
| col 2 is | centered | 12 |
| Alternate lines | are neat | 1 |
| Year | Film | Director | Composer |
|------|-----------------------------------------------|----------------|-------------------|
| 2001 | Harry Potter and the Philosopher's Stone | Chris Columbus | John Williams |
| 2002 | Harry Potter and the Chamber of Secrets | Chris Columbus | John Williams |
| 2004 | Harry Potter and the Prisoner of Azkaban | Alfonso Cuarón | John Williams |
| 2005 | Harry Potter and the Goblet of Fire | Mike Newell | Patrick Doyle |
| 2007 | Harry Potter and the Order of the Phoenix | David Yates | Nicholas Hooper |
| 2009 | Harry Potter and the Half-Blood Prince | David Yates | Nicholas Hooper |
| 2010 | Harry Potter and the Deathly Hallows – Part 1 | David Yates | Alexandre Desplat |
| 2011 | Harry Potter and the Deathly Hallows – Part 2 | David Yates | Alexandre Desplat |
**There must be at least 3 dashes separating each header cell.**
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown inside table cells.
Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3
Blockquotes
Start each line with > + space
.
It is our choices, Harry, that show what we truly are, far more than our abilities.
— Albus Dumbledore
We've all got both light and dark inside us. What matters is the part we choose to act on. That's who we really are.
— Sirius Black
> It is our choices, Harry, that show what we truly are, far more than our abilities.
>
> — **Albus Dumbledore**
> We've all got both light and dark inside us. What matters is the part we choose to act on. That's who we really are.
>
> — **Sirius Black**
Horizontal rule
To create an horizontal rule, just write at least three hyphens ---
, underscore ___
or asterisks ***
.
Hyphens
Asterisks
Underscores
Hyphens
---
Asterisks
***
Underscores
___