Formatting posts with Markdown, BBCode, or HTML

There are several ways to format posts in PagerDuty Community. You can use Markdown, BBCode, and some basic HTML tags to format your text, and even use multiple formatting types within the same post if needed to get your post looking exactly the way you want.

Writing

Text

You can italicize text using any of the following methods.

Editor view:

*Pagey ran*
_Pagey ran_
[i]Pagey ran[/i]
<em>Pagey ran</em>
<i>Pagey ran</i>

Rendered output:

Pagey ran

There are also several ways to highlight important information in bold text.

Editor view:

**Pagey cheered**
__Pagey cheered__
[b]Pagey cheered[/b]
<strong>Pagey cheered</strong>
<b>Pagey cheered</b>

Rendered output:

Pagey cheered

Lists

You can create bulleted and numbered lists, and even add nested items with different list types, just by adding a bullet or number (and spaces, for nested items) at the start of a line with your list’s items.

Editor view:

* Item
- Item
* Item with sub-items
  1. Sub-item
     * Sub-item
* Item

Rendered output:

  • Item
  • Item
  • Item with sub-items
    1. Sub-item with sub-item
      • Sub-item
  • Item

Editor view:

1. Item
2) Item
3. Item with sub-items
   1. Sub-item
      * Sub-item
4. Item

Rendered output:

  1. Item
  1. Item
  1. Item with sub-items
    1. Sub-item with sub-item
      • Sub-item
  2. Item

:eye: Watch out: You’ll need to prepend a few more spaces for sub-items in numbered lists than you would for bulleted lists.

Links

Any bare URLs you post will automatically be made clickable as long as there’s at least one space before the URL, or if the URL is at the very beginning of a new line:

Editor view:

Be sure to check out PagerDuty's Ops Guides at https://www.pagerduty.com/ops-guides/

Looking for in-person training? PagerDuty University has you covered:
https://summit.pagerduty.com/summit2019/pdu

Rendered output:

Be sure to check out PagerDuty’s Ops Guides at https://www.pagerduty.com/ops-guides/

Looking for in-person training? PagerDuty University has you covered:
https://summit.pagerduty.com/summit2019/pdu


Some URLs posted on a line by themselves, with no spaces in front will automatically expand to include a preview of the content, like this tweet URL:


Want to customize the text that shows up for your link? Try one of these methods:

Editor view:

[PagerDuty Engineering Blog](https://www.pagerduty.com/eng/)
[url=https://www.pagerduty.com/eng/]PagerDuty Engineering Blog[/url]
<a href="https://www.pagerduty.com/eng/">PagerDuty Engineering Blog</a>

Rendered output:

PagerDuty Engineering Blog

You can also use reference-style links, however, keep in mind there must be at least one blank line above your first reference URL if you wish to use this style.

Editor view:

[PagerDuty Engineering Blog][1]

[1]: https://www.pagerduty.com/eng/

Rendered output:

PagerDuty Engineering Blog

:information_source: Note: We add rel=nofollow to all user-generated content (except for PagerDuty links) until you teach trust level 3.

Lines

You may have noticed the horizontal lines separating the different list and linking options in the previous sections. There are multiple ways you can add horizontal lines to your posts if you wish to break up different sections.

Editor view:

---
***
<hr>

Rendered output:


Headings

Another way you can break up your content in a large post is to add headings and a table of contents. This is done by adding a number sign (or “hash,” #) at the start of a line.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Table of Contents

You can easily add a table of contents to any post that has headings by setting the first line of your post to:

<div data-theme-toc="true"> </div>

:information_source: Note: You won’t see the table of contents in the editor preview; the table of contents will only be visible once your post is live.


Code

You can share code in the forums both inline and in dedicated blocks.

Inline code formatting is perfect for use in sentences and only requires a single backtick (`) around your code snippet.

Editor view:

For security, PagerDuty Community doesn't support the `<script>` tag.

Rendered output:

For security, PagerDuty Community doesn’t support the <script> tag.

Code blocks are appropriate if you wish to share more than a single line of code, and they provide automatic code highlighting. You can create a code block with three backticks (```) on a line before and after the code you’re sharing.

Editor view:

```
func (c *EscalationPolicyCreate) Help() string {
	helpText := `
	pd escalation-policy create <FILE> Create a new escalation policy
	` + c.Meta.Help()
	return strings.TrimSpace(helpText)
}
```

Rendered output:

func (c *EscalationPolicyCreate) Help() string {
	helpText := `
	pd escalation-policy create <FILE> Create a new escalation policy
	` + c.Meta.Help()
	return strings.TrimSpace(helpText)
}

Blockquotes

You can share quotes by adding a greater than (>) sign at the start of the quoted text.

Editor view:

> Our employees dedicate 1% of all working time towards improving the local and global community through volunteer work. If you need a hand, contact us --- we want to help.

Rendered output:

Our employees dedicate 1% of all working time towards improving the local and global community through volunteer work. If you need a hand, contact us — we want to help.

Tables

If you have data you wish to display in a table, you can use pipes (|) and dashes (-) to create rows with headings and data. Colons (:) can be used on the heading separator to specify left (the default), center, or right alignment, if desired.

Editor view:

| City          | State/Province | Country |
| ------------- | :------------: | ------: |
| San Francisco | CA             | US      |
| Toronto       | ON             | CA      |
| Seattle       | WA             | US      |
| Sydney        | NSW            | AU      |
| London        |                | GB      |
| Atlanta       | GA             | US      |

Rendered output:

City State/Province Country
San Francisco CA US
Toronto ON CA
Seattle WA US
Sydney NSW AU
London GB
Atlanta GA US

Media

Images

You can click the upload icon in the editor toolbar, or drag-and-drop images from your computer to the editor to upload an image file from your computer. You can also use one of the following to embed an image from the web:

![Alt Text|WxH](URL)
<img src="URL" alt="Alt Text" width="#" height="#">

:left_right_arrow: Sizing optional: If you don’t manually specify your desired image width or height, we’ll automatically scale the image down to a presentable size for you.

Editor view:

![Pagey at NYSE](https://image.cnbcfm.com/api/v1/image/105846738-1555004629834pagerduty.jpg)
<img src="https://image.cnbcfm.com/api/v1/image/105846738-1555004629834pagerduty.jpg" alt="Pagey at NYSE">

Rendered output:

:information_source: Note: We’ll automatically download a copy of any remote images shortly after you publish your post, then modify your post to reference the copy instead. This prevents images used in the PagerDuty Community from breaking in the future, from being changed to something else without the post author’s knowledge, and even helps site owners by not hotlinking.

:framed_picture: Copyright: PagerDuty respects the intellectual property rights of others and expects its users to do the same. Don’t upload content you don’t have permission to distribute.

Submit a DMCA takedown notice

Audio/Video

You can embed YouTube, Vimeo, SoundCloud, and other media content in your post simply by putting the original URL on its own line in your post.

Editor view:

https://www.youtube.com/watch?v=BvxbhXyfX_w

Rendered output:

Editor view:

https://vimeo.com/271518517

Rendered output:

Editor view:

https://soundcloud.com/pagerduty/somethings-broken

Rendered output:

Advanced Features

Escape Formatting

If you want to use a character that provides formatting you don’t want to use, like the dash (-), try prepending a backslash (\) to escape that character’s special purpose.

Editor view:

Thanks!

\- Pagey

Rendered output:

Thanks!

- Pagey

View Post Source

Want to see how specific formatting was achieved on a post? You can view the source for any post by modifying the URL in your web browser’s address bar. Simply replace the part of the URL that reads t/topic-subject with the word raw.

Standard view:

https://community.pagerduty.com/t/welcome-to-the-pagerduty-community/8

Source view:

https://community.pagerduty.com/raw/8

1 Like