Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include Markdown Syntax Information #1994

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Include Markdown Syntax Information #1994

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eae6073
Include Markdown Syntax Information
chrstinalin Jan 20, 2025
8b93a9a
add field info
chrstinalin Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions src/content/documentation/publish/create-an-appealing-listing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,86 @@ And, when users suggest improvements or highlight issues in the reviews, use the

<!-- Single Column Body Module -->

<section id="make-use-of-markdown" class="module">
<article class="module-content grid-x grid-padding-x">
<div class="cell small-12">

## Make use of Markdown

Some fields in your add-on's listing support a limited set of Markdown.
<table>
<thead>
<tr>
<th scope="col">Style</th>
<th scope="col">Syntax</th>
<th scope="col">Example</th>
<th scope="col">Output</th>
</tr>
</thead>
<tbody>
<tr>
<td>Bold</td>
<td><code>** **</code> or <code>__ __</code></td>
<td><code>**This is bold**</code></td>
<td><strong>This is bold</strong></td>
</tr>
<tr>
<td>Italic</td>
<td><code>* *</code> or <code>_ _</code>     </td>
<td><code>_This is italicized_</code></td>
<td><em>This is italicized</em></td>
</tr>
<tr>
<td>Links</td>
<td><code>[Text](Link)</code></td>
<td><code>[Click me!](https://addons.mozilla.org/)</code></td>
<td><a href="https://addons.mozilla.org/">Click me!</a></td>
</tr>
<tr>
<td>Abbreviations</td>
<td><code>*[abbr]: Abbreviation</code></td>
<td><code>*[HTML]: Hyper Text Markup Language</code></td>
<td><abbr title="Hypertext Markup Language">HTML</abbr></td>
</tr>
<tr>
<td>Blockquote</td>
<td><code>&gt;</code></td>
<td><code>&gt; This is a blockquote.</code></td>
<td><blockquote>This is a blockquote.</blockquote></td>
</tr>
<tr>
<td>Code</td>
<td><code>```</code></td>
<td><code>
```<br/>console.log("Hello, world!");<br/>```
</code></td>
<td><code>console.log("Hello, world!");</code></td>
</tr>
<tr>
<td>Unordered Lists</td>
<td><code>-</code>, <code>*</code>, or <code>+</code></td>
<td><code>- List Item
</code></td>
<td><ul><li>List item</li></ul></td>
</tr>
<tr>
<td>Ordered Lists</td>
<td><code>1.</code>, <code>2.</code>, <code>3.</code> ...</td>
<td><code>1. List Item
</code></td>
<td><ol><li>List item</li></ol></td>
</tr>
</tbody>
</table>

</div>
</article>
</section>

<!-- END: Single Column Body Module -->

<!-- Single Column Body Module -->

<section id="some-other-points" class="module">
<article class="module-content grid-x grid-padding-x">
<div class="cell small-12">
Expand Down
4 changes: 4 additions & 0 deletions src/data/pages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,6 +1059,10 @@
"title": "Gently ask for a review",
"id": "gently-ask-for-a-review"
},
{
"title": "Make use of Markdown",
"id": "make-use-of-markdown"
},
{
"title": "Some other points",
"id": "some-other-points"
Expand Down
Loading