Markdown

31st May 2018 by Pedr Browne

440 Words / 4 Minute Read

Both Pages, Articles and Projects support an extended superset of Markdown via Github Flavoured Markdown. Markdown documents support frontmatter for defining data associated with the markdown document.

You’ll find an outline of the supported markdown elements below, or for more in depth information see Remark’s own outline here.

Headings

Heading are translated to the appropriate h tags, meaning that even though the page title is rendered outside the markdown, you don’t have to skp using primary headings.

# Primary

## Secondary

### Tertiary

Primary

Secondary

Tertiary

Paragraphs

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer sagittis metus
eget sapien fermentum, sit amet maximus diam auctor. Suspendisse a dignissim
tortor. Suspendisse vulputate risus purus, eget maximus diam maximus at. Sed
sollicitudin nec est in congue. Quisque quam nulla, fringilla sed volutpat sed,
fringilla non sapien. Sed tincidunt, turpis eget commodo pretium, nulla ligula
faucibus dui, sed tempus urna arcu eget nibh. Nunc et placerat turpis, placerat
lobortis metus. Aliquam eu tincidunt orci, nec placerat nulla. Sed facilisis et
dolor vitae efficitur. Pellentesque varius justo feugiat auctor varius. Quisque
et diam urna. Vivamus dapibus diam et magna rhoncus bibendum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer sagittis metus eget sapien fermentum, sit amet maximus diam auctor. Suspendisse a dignissim tortor. Suspendisse vulputate risus purus, eget maximus diam maximus at. Sed sollicitudin nec est in congue. Quisque quam nulla, fringilla sed volutpat sed, fringilla non sapien. Sed tincidunt, turpis eget commodo pretium, nulla ligula faucibus dui, sed tempus urna arcu eget nibh. Nunc et placerat turpis, placerat lobortis metus. Aliquam eu tincidunt orci, nec placerat nulla. Sed facilisis et dolor vitae efficitur. Pellentesque varius justo feugiat auctor varius. Quisque et diam urna. Vivamus dapibus diam et magna rhoncus bibendum.

Weight / Styles

_Italic_, **Bold**, **_Bold italic_**

Italic, Bold, Bold italic

Typographic embellishments

There are a number of additional typographic embellishments that will happen automatically.

Quotes

Single and double quotes will be replaced by printers quotes:

"Double" and 'Single'

“Double” and ‘Single’

Ellipses

If you type three dots, they will be replaced by the ellipsis character:

And then...

And then…

Dashes

The type of dash can be controlled by the number of dashes used:

En Dash (Two dashes)

5--10

5–10

Em Dash (Three dashes)

5---10

5—10

Strikethrough

Wrapping text in two tilde (~) characters will strike it through:

~~Example~~

Example

Links

[imperdiet](http://example.com)

imperdiet

Lists

Unordered

* Mauris tristique elementum leo a viverra. Ut placerat, ex nec vestibulum
  iaculis. Erat graecis mei ex
* His id dolorem indoctum facilisis
* In per deseruisse appellantur
  • Mauris tristique elementum leo a viverra. Ut placerat, ex nec vestibulum iaculis. Erat graecis mei ex
  • His id dolorem indoctum facilisis
  • In per deseruisse appellantur

Ordered

1. Mauris tristique elementum leo a viverra. Ut placerat, ex nec vestibulum
  iaculis. Erat graecis mei ex
2. His id dolorem indoctum facilisis
3. In per deseruisse appellantur
  • Mauris tristique elementum leo a viverra. Ut placerat, ex nec vestibulum iaculis. Erat graecis mei ex
  • His id dolorem indoctum facilisis
  • In per deseruisse appellantur

Blockquote

> Vix porro noster ei, no usu facilis elaboraret. No debitis pertinacia pro,
> nisl delenit pertinacia ad vis, in soluta dissentiet usu. Mundi iuvaret
> inermis vim at, an graeco feugait contentiones mea, nec porro minimum
> reformidans ut. Consul argumentum instructior et mei.

<cite>Quisque Quam Nulla</cite>

Vix porro noster ei, no usu facilis elaboraret. No debitis pertinacia pro, nisl delenit pertinacia ad vis, in soluta dissentiet usu. Mundi iuvaret inermis vim at, an graeco feugait contentiones mea, nec porro minimum reformidans ut. Consul argumentum instructior et mei.

Quisque Quam Nulla

Horizontal Rule

---

Code

Blocks

```javascript
  const x = 1;
```
  const x = 1;

Inline

Lorem `ipsum` dolor sit amet

Lorem ipsum dolor sit amet

Tables

Although tables are not supported in basic Markdown, they are here using the GFM Markdown syntax. This can be fidly, but you’ll find a handy table generator here

| Column 1      | Column 2      | Column 3 |
| ------------- |-------------- | -------- |
| Alpha         | 1             | A        |
| Bravo         | 2             | B        |
| Charlie       | 3             | C        |
Column 1Column 2Column 3
Alpha1A
Bravo2B
Charlie3C

Footnotes

Add footnote references:

Civibus efficiendi[^1] complectitur his at. Est stet[^2] aeque voluptaria eu, eum scaevola.

[^1]: First footnote is here
[^2]: And the second is here

Civibus efficiendi1 complectitur his at. Est stet2 aeque voluptaria eu, eum scaevola.


Plugins Used


  • First footnote is here

  • And the second is here