HELP ARTICLE /
Other
PocketRN Custom Markdown Formatting
In this article, we go over the different supported markdown formats and how to write them. Some markdown elements are custom created for use within PocketRN.
Articles
Caregiver Account
Markdown is a simple way to format text using special characters rather than a menu of styling options. This guide will help you with the various text formats of markdown, including headers, lists, links, and custom additions specific for PocketRN. PocketRN supports markdown in most of the multiline text fields you'll find in the platform.
Block Formats
Headers
Markdown supports six levels of headers, using the # symbol:
# = Header 1## = Header 2### = Header 3#### = Header 4##### = Header 5###### = Header 6
Example:
### This is a header 3
This is a paragraph after a header.
Paragraphs
Paragraphs are created by simply writing text. If you want a new paragraph, separate text with a blank line.
Example:
This is a paragraph.
This is another paragraph.
Ordered Lists
To create ordered lists, start a new line starting with a period . then
type the list item.
Example:
. First item
. Second item
. Third item
Displays as:
- First item
- Second item
- Third item
Unordered Lists
Unordered lists use an asterisk * but are otherwise just like ordered
lists.
Example:
* First item
* Second item
* Third item
Displays as:
- First item
- Second item
- Third item
Blockquote
To create blockquotes, use three greater-than signs >>> at the
beginning of the line.
Example:
>>> This is a blockquote.
Displays as:
This is a blockquote.
Horizontal Rule
To create a horizontal rule, use three hyphens ---.
Example:
A paragraph before a horizontal rule.
---
A paragraph after a horizontal rule.
Inline Formats
Here are the inline formats that markdown supports. As a note, inline formatting options cannot span multiple lines.
Bold
To create bold text, use double asterisks **.
Example:
Text before **bold text** and after it.
Displays as:
Text before bold text and after it.
Italics
To create italic text, use either an underscore _ or a single asterisk
*.
Example:
Text before _italics text_ or an *alternative italics* and after it.
Displays as:
Text before italics text or an alternative italics and after it.
Links
To create a link, use square brackets [] for the text, followed by the link
in parentheses ().
Example:
[Google](https://www.google.com)
Displays as:
Absolute vs Relative Links:
-
Absolute links: These include the full URL (e.g.,
https://www.example.com) and will typically open in a new tab when clicked. -
Relative links: These are paths that lead to somewhere else within
the PocketRN app (e.g.,
/meetings). They will redirect the app to that page.
Strikethrough
To create strikethrough text, use double tildes ~~.
Example:
Text before ~~strikethrough text~~ and after it.
Linebreak
To force a line break without starting a new paragraph, use <br>.
These do not have the same additional padding/spacing you get when making two
paragraphs; the second paragraph will be snugly beneath the first. We do not recommend
using linebreaks to wrap words to a new line because you are likely only experiencing
the wrap at a particular screen size.
Example:
This is the first line.<br>This is the second line.
Displays as:
This is the first line.
This is the second line.
Custom Markdown Elements
We also support a few markdown elements that are not part of standard markdown.
Notes
To create a note, use a caret ^ at the beginning of a line. The text will
display smaller to indicate a note.
Example:
^This is a note.
Unsupported Markdown Elements
There are several markdown elements that we do not yet support. If an element is not listed here, it will not work.