OWN3D Design Panel Extension now offers Markdown!
Hey fellow streamers!
With the release of the new version 1.1.0 of our OWN3D Design Panel Extension, we are proud to announce that the extension now offers markdown (Showdown).
While you can find the full list of the supported markdown here, there is a summary of the most important features here:
Paragraphs
Paragraphs in markdown are just one or more lines of consecutive text followed by one or more blank lines.
On July 2, an alien mothership entered Earth's orbit and deployed several dozen
saucer-shaped "destroyer" spacecraft, each 15 miles (24 km) wide.
On July 3, the Black Knights, a squadron of Marine Corps F/A-18 Hornets,
participated in an assault on a destroyer near the city of Los Angeles.
The implication of the “one or more consecutive lines of text” is that markdown supports “hard-wrapped” text paragraphs. This means the following examples produce the same output:
A very long line of text
A very
long line
of text
If you DO want to add soft line breaks (which translate to <br> in HTML) to a paragraph, you can do so by adding 3 space characters to the end of the line ().
You can also force every line break in paragraphs to translate to <br> (as Github does) by enabling the option simpleLineBreaks.
Headings
Atx Style
You can create a heading by adding one or more # symbols before your heading text. The number of # you use will determine the size of the heading. This is similar to atx style.
# The largest heading (an <h1> tag)
## The second largest heading (an <h2> tag)
…
###### The 6th largest heading (an <h6> tag)
The space between # and the heading text is not required but you can make that space mandatory by enabling the option requireSpaceBeforeHeadingText.
You can wrap the headings in #. Both leading and trailing # will be removed.
## My Heading ##
If, for some reason, you need to keep a leading or trailing #, you can either add a space or escape it:
# # My header # #
#\# My Header \# #
Bold and Italic
You can make text bold or italic.
*This text will be italic*
**This text will be bold**
Both bold and italic can use either a * or an _ around the text for styling. This allows you to combine both bold and italic if needed.
**Everyone _must_ attend the meeting at 5 o'clock today.**
Strikethrough
With the option strikethrough enabled, markdown supports strikethrough elements. The syntax is the same as GFM, that is, by adding two tilde (~~) characters around a word or groups of words.
a ~~strikethrough~~ element
a strikethrough element
Emojis
Since version 1.8.0, markdown supports github’s emojis. A complete list of available emojis can be foun here.
this is a :smile: smile emoji
this is a 
Lists
Markdown supports ordered (numbered) and unordered (bulleted) lists.
Unordered lists
You can make an unordered list by preceding list items with either a *, a – or a +. Markers are interchangeable too.
* Item
+ Item
- Item
Ordered lists
You can make an ordered list by preceding list items with a number.
1. Item 1
2. Item 2
3. Item 3
It’s important to note that the actual numbers you use to mark the list have no effect on the HTML output markdown produces. So you can use the same number in all items if you wish to.
List syntax
List markers typically start at the left margin, but may be indented by up to three spaces.
* this is valid
* this is too
List markers must be followed by one or more spaces or a tab.
To make lists look nice, you can wrap items with hanging indents:
* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
viverra nec, fringilla in, laoreet vitae, risus.
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
Suspendisse id sem consectetuer libero luctus adipiscing.
But if you want to be lazy, you don’t have to
If one list item is separated by a blank line, markdown will wrap all the list items in <p> tags in the HTML output. So this input:
* Bird
* Magic
* Johnson
Results in:
<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
<li><p>Johnson</p></li>
</ul>
This differs from other markdown implementations such as GFM (github) or commonmark.