############################### Marketplace Markdown Guide ############################### When you submit an item to the Marketplace, you can format your item description using Markdown syntax. *Markdown* is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, including HTML. Below, you can find the commands that we support for Markdown for Marketplace descriptions. * `Headings`_ * `Emphasis`_ * `Line Breaks`_ * `Blockquotes`_ * `Lists`_ * `Images`_ * `Links`_ * `Code Samples`_ * `Horizontal Rules`_ ^^^^^^^^^^^^^^^^^^^^^^ Headings ^^^^^^^^^^^^^^^^^^^^^^ .. raw:: html
| Markdown Syntax | HTML | Output |
|---|---|---|
| # h1 Heading | <h1>h1 Heading</h1> | h1 Heading |
| ## h2 Heading | <h2>h2 Heading</h2> | h2 Heading |
| ### h3 Heading | <h3>h3 Heading</h3> | h3 Heading |
| Markdown Syntax | HTML | Output |
|---|---|---|
| *italicized text* _italicized text_ |
<em>italicized text</em> | italicized text |
| ** bold text** __bold text__ |
<strong>bold text</strong> | bold text |
| ***bold AND italicized text*** ___bold AND italicized text___ |
<strong><em>bold AND italicized text</em></strong> | bold text |
| ~~strikethrough~~ | <del>strikethrough</del> |
| Markdown Syntax | HTML | Output |
|---|---|---|
| I really like using Markdown. I think I'll use it to format all of my documents from now on. |
<p>I really like using Markdown.</p> <p>I think I'll use it to format all of my documents from now on.</p> |
I really like using Markdown. I think I'll use it to format all of my documents from now on. |
| This is the first line. And this is the second line. |
<p>This is the first line.<br>And this is the second line.</p> | This is the first line. And this is the second line. |
This is a blockquoteBlockquotes can contain multiple paragraphs. Add a > on the blank lines between the paragraphs. .. code:: > This is a blockquote. > > It has a second paragraph. The rendered output looks like this: .. raw:: html
This is a blockquote.
It has a second paragraph.
You can also nest blockquotes: .. code:: > This is a blockquote. >> The second paragraph is nested. The rendered output looks like this: .. raw:: html
This is a blockquote.^^^^^^^^^^^^^^^^^^ Lists ^^^^^^^^^^^^^^^^^^ To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one. To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list. ^^^^^^^^^^^^^^^^^^ Images ^^^^^^^^^^^^^^^^^^ .. raw:: htmlThe second paragraph is nested.
| Markdown Syntax | HTML |
|---|---|
|  | <img src="image.png" alt="alt text" /> |
| Markdown Syntax | HTML | Output |
|---|---|---|
| <https://www.highfidelity.com> | <a href="https://www.highfidelity.com"> https://www.highfidelity.com </a> |
https://www.highfidelity.com |
| [High Fidelity](https://www.highfidelity.com) | <a href="https://www.highfidelity.com">High Fidelity</a> |
High Fidelity |
| <support@highfidelity.io> | <a href="mailto:support@highfidelity.io"> support@highfidelity.io </a> |
support@highfidelity.io |
| Markdown Syntax | HTML | Output |
|---|---|---|
| `inline code` | <code>inline code</code> | Here is some inline code. |
| ``` block of code ``` |
<pre>block of code</pre> |
block |
| Markdown Syntax | HTML | Output |
|---|---|---|
| ___ --- *** |
<hr /> |