Using Markdown in Semaphor

Last updated

This article has moved to our new Help Center and will no longer be updated on this page. Please see the Help Center for the newest version.

Beginning with version 1.2.1 of Semaphor, Markdown can now be used to format your messages!

We currently offer support for bold, italics, strikethrough, lists, blockquotes, and code blocks in Markdown.

To emphasize text:

Italics use either *asterisks* or _underscores_

Bold uses either **double asterisks** or __double underscores__

This can be combined if you'd like, using **asterisks and _underscores_**.

Strikethrough uses ~~two tildes~~. Strike that!

Lists:

For this example, leading and trailing spaces will be represented by a dot (·) so they're more evident. For use in Semaphor, simply use as many spaces as there are dots in this example.

1. First ordered list item  
2. Second in the ordered list  
···* Unordered sub-list  
8. You can use any number - this will still be 3. on the list. As long as it's a number  
···1. A sub-list, also ordered  
4. Another item.

···You can have indented paragraphs within list items. See that there is a blank line above this, and a leading space ahead of this. Only one leading space is required to indent the paragraph.

···If you want a line break without a paragraph, leave two trailing spaces after the line··  
···This line is separate, but it's still in the same paragraph!··  
···You can also use **Markdown** in lists _if you want_.··

* Oh, and if you just want an unordered list, you can use an asterisk  
- Or a minus sign  
+ Or even a plus sign

The above list would look like this in Markdown:

1. First ordered list item  
2. Second in the ordered list  
   * Unordered sub-list
3. You can use any number - this will still be 3. on the list. As long as it's a number
   1. A sub-list, also ordered
4. Another item.

  You can have indented paragraphs within list items. See that there is a blank line above this, and a leading space ahead of this. Only one leading space is required to indent the paragraph.

  If you want a line break without a paragraph, leave two trailing spaces after the line.  
  This line is separate, but it's still in the same paragraph!

 You can also use **Markdown** in lists _if you want_.

* Oh, and if you just want an unordered list, you can use an asterisk  
* Or a minus sign  
* Or even a plus sign
Blockquotes:

To create a blockquote, preface the line with a >

> For example, this will be a blockquote.
> Even though this is a separate line, it will still be part of the same quote.

For example, this will be a blockquote.  Even though this is a separate line, it will still be part of the same quote.

If you want to have two separate blockquotes, you will need a break in between.

> So this would be your first blockquote.
> This would be part of the first block.
> So would this.

Let's put a break in!

> This would start the second blockquote.
> This would be part of the second.

So this would be your first blockquote. This would be part of the first block. So would this.

Let's put a break in!

This would start the second blockquote. This would be part of the second.
Code

If you need to insert a line or block of text which is monospaced and retains formatting, you can use code blocks and snippets.

For a code block, use three ``` ahead of the text you wish to format. The backticks should be on their own line, such as:

```
This would be in a monospace font in Semaphor 
     and will take up as many lines as you need it to
         and will preserve  the      formatting.
   It will display exactly as you type it, which is
            pretty           handy. 

The above would be what you would see in Semaphor, without the leading backticks.

Likewise, you can insert just a code snippet, or a block of monospace text, by using a single `.

like this!

The Markdown doesn't need to be closed for code blocks or snippets, unless you're including it in a line or block of text with other text which doesn't need the formatting. If you do need to close a code block, the closing backticks should be on their own line.

Other Markdown will be stripped in a code block/snippet, so you won't be able to make the text within a code block bold or underlined.