Markdown examples

Although the Gutenberg Block Editor is the default in this WordPress version, Posts and Pages can be composed using plain text Markdown. The syntax is reasonably simple and should be more than sufficient for most content. This page illustrates some of the Markdown constructs you might want to use. It is not necessary to learn (much) Markdown but there are some circumstances where it can make life easier.

The two most common are:

1. quick syntax highlighting. Just enclose your code fragment with backticks or use the fence blocks for multiple lines. There is a separate page about syntax highlighting.
2. Building tables. This, for me, is the most important feature. HTML tables are a pain to generate and edit. Markdown tables are a joy to use for any data presentation. Any data source worth its salt can be made to generate plain text, markdown compatible tables as output. Even where that is not possible, it is not difficult to take, for example, comma or tab delimited data and use a competent text editor to insert the appropriate markup.
   There will soon be a whole page dedicated to getting good data tables.

Jetpack uses Markdown Extra by Michel Fortin. It includes some features not originally available in Markdown, including improved support for inline HTML, code blocks, tables, and more. Code blocks can use three or more back ticks (“`), as well as tildes (~~~).

See the WordPress.com Markdown Quick Reference page for the most useful formatting and features offered by Markdown Extra.

Emphasis

Blockquotes

Blockquotes are very handy in email to emulate reply text or as pullquotes from an article
This line is part of the same quote.

There must be a plain paragraph to restore normal flow

Long lines will correctly indent when they wrap. Thus you can say al much as you like after that initial blockquote symbol and the line will behave perfectly properly.

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

…although this can get out of hand.

Lists

Unordered

• Create a list by starting a line with +, -, or *
• Sub-lists are made by indenting 3 spaces:
  • Be consistent with the markers – they may start a new list sequence
  • Handy when you want to start a new list
    1. inside
    2. unordered
    3. lists
    4. I suppose
  • Facilisis in pretium nisl aliquet
  • Nulla volutpat aliquam velit
• Very easy!
• Really.

Ordered

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa

A new paragraph breaks the sequence

1. You can use sequential numbers…
2. …or keep all the numbers as 1.

Lists always start at 1:

1. Lions
2. Kangaroos
3. Crocodiles
4. Birds
5. Reptiles
6. Marsupials

Code

See the Syntax highlighting page for more about how to include code in a post.

<span class="token keyword">float</span> <span class="token function">magnitude</span><span class="token punctuation">(</span><span class="token keyword">float</span> a<span class="token punctuation">,</span> <span class="token keyword">float</span> b<span class="token punctuation">,</span> <span class="token keyword">float</span> c<span class="token punctuation">)</span> <span class="token punctuation">{</span>
  <span class="token keyword">return</span> <span class="token function">sqrt</span><span class="token punctuation">(</span>a <span class="token operator">*</span> a <span class="token operator">+</span> b <span class="token operator">*</span> b <span class="token operator">+</span> c <span class="token operator">*</span> c<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>

Tables

Aligned columns don’t seem to work without a modification to the parent theme

Links

Links have some displayed text and an associated URL and an optional title that will be displayed when the link is hovered.:

Images

Images can be hosted anywhere – they are simply specified by their location. Alt text can be added for a more user friendly experience See the Adding Images page for more details.

Markdown	Render


Footnotes

Handy if you have something else ¹ to add to a statement ² for some reason.

The actual footnote ³ can be written close to its original reference point and it will still be inserted at the foot of the page.

The same footnote can be referenced from several places³.

And a footnote can contain markup⁴

Referenced Links

These are places where you might want to have several links on the page to the same destination but only want to write the actual destination URL once.

Some text with a link and another link to the same destination. This is a different destination that we could reuse several times.

Definition lists

A Definition list can be a handy construct even if the content is not strictly a definition. For example, it can be a convenient way to make a series of titled paragraphs.

Admiration, n.

Our polite recognition of another’s resemblance to ourselves.

Back, n.

That part of your friend which it is your privilege to contemplate in your adversity.

Consul, n.

In American politics, a person who having failed to secure an office from the people is given one by the Administration on condition that he leave the country.

Advisor, n.

A male relative of an office-holder’s offspring. The advisor is commonly a beautiful young man, with a red necktie and an intricate system of cobwebs extending from his nose to his desk.
When accidentally struck by the janitor’s broom, he gives off a cloud of dust.