Markdown lets you compose posts and comments with links, lists, and other styles using regular characters and punctuation marks.
Markdown is used by writers and bloggers who want a quick and easy way to write rich text without having to take their hands off the keyboard and without learning a lot of complicated codes and shortcuts.
You can use Markdown on your Jetpack-powered blog for posts, pages, and comments. This document will detail how to enable Markdown on your blog and write with it.
If you are already familiar with Markdown, just enable it on your blog and start writing; refer to the WordPress.com Markdown Quick Reference page for help. Jetpack uses Markdown Extra, which adds some features not originally available in Markdown. For best results, please use the Text tab in the Editor as the Visual editor can give unexpected results. See below for more details.
This guide only applies to posts created with the Classic Editor. See the Jetpack Markdown Block support guide for more information.
Enabling Markdown
From the Jetpack page in your Dashboard, go to Settings → Writing and activate the “Write posts or pages in plain-text Markdown syntax” option in the Composing section.
Enable Markdown.
Once activated, Markdown is enabled for posts and pages and is available to all users on your blog.
To enable Markdown for comments, go to Settings → Discussion → Comments in your dashboard, and toggle the option labeled Enable Markdown use for comments. Click on Save Settings to apply. Visitors to your blog will now be able to compose comments using Markdown.
Enabling Markdown for comments
Writing with Markdown
Markdown uses special characters and punctuation marks to indicate styles and links. The specific characters you use and how you place them in the document are key to how your document will be formatted.
Markdown converts these special characters to the appropriate formatting when the document is published. For best results, use the Text tab in the Editor. The Visual Editor can produce unexpected results.
For example, in Markdown, to emphasize a word, you wrap it with an asterisk on both ends, like this: *emphasized*. When your writing is published, it will look like this: emphasized. Similarly, two asterisks denote strong text: **strong** will be published as strong.
To indicate links, use regular and square parentheses. Wrap the text you want to link in square parentheses; immediately after it, insert the link target, wrapped in regular parentheses. The actual Markdown could look like this: [Jetpack.com](https://jetpack.com/). When published, it will be a standard link: Jetpack.com.
On the left: using Markdown to compose a post in the fullscreen editor. On the right: The published post.
The original Markdown text you write will always remain in Markdown, so you can go back and edit it using Markdown. Only the published document – the post or the page – will be converted.
If you write a post in Markdown, it will be published as a fully formatted post on your blog, but when you go back and edit, it’ll still be in Markdown.
The best way to get started with Markdown is to experiment. Open the Markdown Quick Reference guide, start a draft post on your blog, and try to use the different features.
Markdown Extra and Markdown in Jetpack
Jetpack uses Markdown Extra by Michel Fortin. It includes features not originally available in Markdown, including improved support for inline HTML, code blocks, tables, and more. Code blocks can use three or more backticks (```), as well as tildes (~~~).
However, the Markdown block currently follows the CommonMark spec. For more information, you can refer to the official CommonMark spec.
About Markdown
Markdown was created by John Gruber and Aaron Swartz in 2004 as a solution for easily composing richly formatted text on the web. It employs plain text only and is based on conventions established in the computer and technology industry for writing emails and other documents with limited resources.
In plain text documents, the text you see on the screen represents all the information in the file, with no formatting or other data hidden from view. Plain text documents have been used for decades for their simplicity, portability, and reliability. You can probably still open and edit any plain text document from the past 40 years on any computing device available today.
Markdown has seen popular adoption on the web since it was first introduced, and it is now included in many sites and software programs.
Simplenote is a cross-platform note-taking service by Automattic, with Markdown support.
Add Markdown support to your Custom Post Types.
There are 2 options to add Markdown support to a specific Custom Post Type on your site:
You can add Markdown support to an existing post type thanks to the add_post_type_support() function. To do so, add the following code to a functionality plugin:
add_action('init', 'my_custom_init'); function my_custom_init() { add_post_type_support( 'product', 'wpcom-markdown' ); }
You’ll need to replace “product” with your Custom Post Type name.
You can add Markdown support when registering the post type, like so:
// Register Custom Post Type function custom_post_type() { $labels = array( 'name' => _x( 'Products', 'Post Type General Name', 'text_domain' ), ); $args = array( 'label' => __( 'product', 'text_domain' ), 'supports' => array( 'title', 'editor', 'publicize', 'wpcom-markdown' ), ); register_post_type( 'product', $args ); } // Hook into the 'init' action add_action( 'init', 'custom_post_type', 0 );
Add Markdown support to your Custom Fields
You can follow these instructions to add Markdown support to custom meta fields.
This feature is deactivated by default. If you ever need to deactivate this feature, you can toggle the Write posts or pages in plain-text Markdown syntax setting in the Composing section from Jetpack — Settings — Writing in your dashboard.
Data Used
Site Owners / Users
For activity tracking (detailed below): IP address, WordPress.com user ID, WordPress.com username, WordPress.com-connected site ID and URL, Jetpack version, user agent, visiting URL, referring URL, timestamp of event, browser language, country code.
Site Visitors
None.
Activity Tracked
Site Owners / Users
We track when, and by which user, the feature is activated and deactivated.
Markdown (Classic Editor)
Markdown lets you compose posts and comments with links, lists, and other styles using regular characters and punctuation marks.
Markdown is used by writers and bloggers who want a quick and easy way to write rich text without having to take their hands off the keyboard and without learning a lot of complicated codes and shortcuts.
You can use Markdown on your Jetpack-powered blog for posts, pages, and comments. This document will detail how to enable Markdown on your blog and write with it.
If you are already familiar with Markdown, just enable it on your blog and start writing; refer to the WordPress.com Markdown Quick Reference page for help. Jetpack uses Markdown Extra, which adds some features not originally available in Markdown. For best results, please use the Text tab in the Editor as the Visual editor can give unexpected results. See below for more details.
This guide only applies to posts created with the Classic Editor. See the Jetpack Markdown Block support guide for more information.
Enabling Markdown
From the Jetpack page in your Dashboard, go to Settings → Writing and activate the “Write posts or pages in plain-text Markdown syntax” option in the Composing section.
Once activated, Markdown is enabled for posts and pages and is available to all users on your blog.
To enable Markdown for comments, go to Settings → Discussion → Comments in your dashboard, and toggle the option labeled Enable Markdown use for comments. Click on Save Settings to apply. Visitors to your blog will now be able to compose comments using Markdown.
Writing with Markdown
Markdown uses special characters and punctuation marks to indicate styles and links. The specific characters you use and how you place them in the document are key to how your document will be formatted.
Markdown converts these special characters to the appropriate formatting when the document is published. For best results, use the Text tab in the Editor. The Visual Editor can produce unexpected results.
For example, in Markdown, to emphasize a word, you wrap it with an asterisk on both ends, like this: *emphasized*. When your writing is published, it will look like this: emphasized. Similarly, two asterisks denote strong text: **strong** will be published as strong.
To indicate links, use regular and square parentheses. Wrap the text you want to link in square parentheses; immediately after it, insert the link target, wrapped in regular parentheses. The actual Markdown could look like this: [Jetpack.com](https://jetpack.com/). When published, it will be a standard link: Jetpack.com.
The original Markdown text you write will always remain in Markdown, so you can go back and edit it using Markdown. Only the published document – the post or the page – will be converted.
If you write a post in Markdown, it will be published as a fully formatted post on your blog, but when you go back and edit, it’ll still be in Markdown.
The best way to get started with Markdown is to experiment. Open the Markdown Quick Reference guide, start a draft post on your blog, and try to use the different features.
Markdown Extra and Markdown in Jetpack
Jetpack uses Markdown Extra by Michel Fortin. It includes features not originally available in Markdown, including improved support for inline HTML, code blocks, tables, and more. Code blocks can use three or more backticks (
```
), as well as tildes (~~~
).See the WordPress.com Markdown Quick Reference page for the most useful formatting and features offered by Markdown Extra. For more detailed information, see the original reference guide for Markdown and the Markdown Extra page.
However, the Markdown block currently follows the CommonMark spec. For more information, you can refer to the official CommonMark spec.
About Markdown
Markdown was created by John Gruber and Aaron Swartz in 2004 as a solution for easily composing richly formatted text on the web. It employs plain text only and is based on conventions established in the computer and technology industry for writing emails and other documents with limited resources.
In plain text documents, the text you see on the screen represents all the information in the file, with no formatting or other data hidden from view. Plain text documents have been used for decades for their simplicity, portability, and reliability. You can probably still open and edit any plain text document from the past 40 years on any computing device available today.
Markdown has seen popular adoption on the web since it was first introduced, and it is now included in many sites and software programs.
Add Markdown support to your Custom Post Types.
There are 2 options to add Markdown support to a specific Custom Post Type on your site:
add_post_type_support()
function. To do so, add the following code to a functionality plugin:You’ll need to replace “product” with your Custom Post Type name.
Add Markdown support to your Custom Fields
You can follow these instructions to add Markdown support to custom meta fields.
Still need help?
Please contact support directly. We’re happy to advise.
Privacy Information
This feature is deactivated by default. If you ever need to deactivate this feature, you can toggle the Write posts or pages in plain-text Markdown syntax setting in the Composing section from Jetpack — Settings — Writing in your dashboard.
For activity tracking (detailed below): IP address, WordPress.com user ID, WordPress.com username, WordPress.com-connected site ID and URL, Jetpack version, user agent, visiting URL, referring URL, timestamp of event, browser language, country code.
None.
We track when, and by which user, the feature is activated and deactivated.
None.
We sync a single option that identifies whether or not the feature is activated.
None.
Related