Support Home > Utilities > Markdown Block

Markdown Block

With the Markdown block, you can create formatted content using only regular characters and some punctuation marks. Markdown is used by writers and bloggers who want a quick and easy way to write formatted text, but without having to take their hands off the keyboard, and without learning a lot of complicated codes and shortcuts.

Note: this page describes how to use Markdown when using the Block Editor. You can find instructions on adding Markdown to the Classic editor here.

Requirements

The Markdown block is available on all Jetpack-connected sites. It is a part of the Jetpack Blocks suite and is activated by default. Since it is a block only, it remains available even if you disable the Markdown feature in Jetpack → Settings → Writing → Composing.

The Markdown block does not require a paid upgrade to use. See our Jetpack Blocks article to learn about the available blocks and how to activate them.

Jetpack Blocks require the Block Editor (also referred to as the Gutenberg editor). If you’ve installed the Classic Editor plugin, you will need to switch back to the Block Editor either by:

  • Deactivating the Classic Editor: Go to PluginsInstalled Plugins in your WP Admin and deactivate the Classic Editor plugin.
  • Enabling both editors: If you prefer flexibility, navigate to Settings → Writing in your WP Admin. Set Allow users to switch editors to Yes.

See Using Blocks and the Classic Editor for more details.
It may happen that an editor that comes with a custom theme or plugin prevents you from using the Block Editor. In that case, please contact the respective plugin or theme author for further assistance.

Adding a Markdown block

You can add the Markdown block by searching and/or selecting it from the Jetpack section of the block selector:

markdown block

See Jetpack Blocks for detailed instructions on adding blocks.

Previewing Markdown Content

To ensure your Markdown content appears as intended, you can use the “Preview” option available on the block toolbar.

This allows you to see a real-time rendered version of your Markdown text, making it easy to verify formatting and make any necessary adjustments before publishing your post or page.

Selecting the preview option on the Markdown block toolbar
Selecting the preview option on the Markdown block toolbar

Learning Markdown

It’s easy to get started writing in Markdown! You can see the basics on this page. If you need a more detailed guide, there’s also a 10-minute tutorial.

Here’s a brief overview of some common Markdown elements:

  1. Headers: Use # for headings. The number of # symbols indicates the heading level (e.g., # Heading 1, ## Heading 2, ### Heading 3).
  2. Emphasis: Use * or _ to create italic text (e.g., *italic* or _italic_) and ** or __ for bold text (e.g., **bold** or __bold__).
  3. Lists: Use *, -, or + for unordered lists and numbers followed by a period for ordered lists (e.g., 1. Item 1, 2. Item 2).
  4. Links: Use [link text](URL) to create hyperlinks (e.g., [Jetpack](https://jetpack.com)).
  5. Images: Use ![Alt text](URL) to insert images (e.g., ![Cute kitten](https://example.com/kitten.jpg)).
  6. Blockquotes: Use > before the text to create a blockquote (e.g., > This is a blockquote.).
  7. Code: Use backticks (`) for inline code and triple backticks (```) for code blocks.
  8. Horizontal rules: Use three or more -, *, or _ on a line by themselves to create a horizontal rule.

Adding Footnotes

The Jetpack Markdown block supports footnotes, allowing you to reference and annotate your content. To add footnotes to your Markdown text within the Jetpack Markdown block, follow this simple syntax:

  1. Inline footnote reference: Add [^identifier] after the text that you want to reference. Replace identifier with a unique label for the footnote (e.g., 1, longnote, or any other label you prefer).
  2. Footnote definition: At the end of your text, add a new line starting with [^identifier]: followed by a space and the footnote content. Remember to replace identifier with the unique label you used for the inline footnote reference.
Markdown text with inline and multiline footnotes in Jetpack Markdown block
Markdown text with inline and multiline footnotes in Jetpack Markdown block

Example:

  • Inline footnote reference: Jetpack is a powerful plugin for WordPress, providing numerous features and enhancements.[^1]
  • Footnote definition: [^1]: Learn more about Jetpack and its features at [the official Jetpack website](https://jetpack.com).

For multiline footnotes, indent any additional lines with four spaces or a tab.

Example:

  • Inline footnote reference: WordPress is an open-source content management system used by millions of websites around the world.[^longnote]
  • Multiline footnote definition:
[^longnote]: WordPress was first released in 2003.
    Since then, it has grown to become one of the most popular website-building platforms, powering over 40% of the internet. Its vast ecosystem of plugins, themes, and community support make it a versatile and adaptable choice for many different types of websites. For more information, visit the [official WordPress website](https://wordpress.org).

This new feature enhances your writing experience, making it convenient to provide additional information or citations without disrupting the flow of your text. To verify that footnotes are working correctly, save your draft and view the changes on the frontend of your website.

Markdown Implementation

Our Markdown block uses the markdown-it parser, which supports the CommonMark spec. If you need full details of the syntax that our Markdown block supports, see the markdown-it demo page.

  • Table Of Contents

  • Contact Us

    Need more help? Feel free to contact us.