Using Markdown to Format Text

This article describes how to use Markdown syntax in Jamf Pro to apply formatting (e.g., headings, italics, bold, etc.) to text displayed to users in the following areas:
  • Text PreStage Pane in Enrollment Customization settings (Jamf Pro 10.17 or later)Markdown syntax can be used in the Body Text field configured within a Text PreStage Pane in Enrollment Customization in Jamf Pro.
  • Notification Subject and message fields in Self Service for macOS (Jamf Pro 10.0.0 or later)Markdown syntax can be used with the Notification Subject and Message fields on the Self Service pane for policies, configuration profiles, apps, and eBooks that are configured in Jamf Pro to be made available in Self Service for macOS.
    Note:

    Markdown syntax is not supported in Notification Center and will display as raw Markdown in Notification Center notifications.

  • Maintenance pages (Jamf Pro 9.7 or later)Markdown syntax can be used with the Maintenance Page Message field configured within the Maintenance Pages setting in Jamf Pro.
  • User-initiated enrollment (Jamf Pro 9.4 or later)Markdown syntax can be used with any of the text fields (e.g., Login Page Text, Device Ownership Page Text, etc.) configured within the Messaging pane in the User-Initiated Enrollment settings in Jamf Pro.
  • Item descriptions in Self Service for macOS, Self Service for iOS, and the Self Service web clip (Jamf Pro 9.4 or later)Markdown syntax can be used with any of the Description fields on the Self Service pane for policies, configuration profiles, apps, and eBooks that are configured in Jamf Pro to be made available in Self Service.

This article also describes how to use Markdown to add hyperlinks and images.

Supported Markdown Formatting

FormattingMarkdown Syntax ExamplesNotes
Headings
Apply heading formatting to text using hash marks at the beginning of a line, with the number of hash marks corresponding to the heading level.
# This is H1
## This is H2
### This is H3
#### This is H4
##### This is H5
###### This is H6
Emphasize (italicize) text
Use either single asterisks or single underscores around text to be italicized.
*my italicized text*
_my italicized text_
Strong (bold) text
Use either double asterisks or double underscores around text to be bolded.
**my bolded text** 
__my bolded text__
Hyperlinks
Add text to be hyperlinked within brackets, followed by parentheses containing the destination URL and optional help tag text.
[my link text](http://example.com/)
[my link text](http://example.com/ "Optional help tag text")
Not supported in Enrollment Customization
Images
Images can be added on a separate line or inline with text. For an image, add an exclamation mark, followed by optional ALT text for the image in brackets, and then the URL of the image in parentheses.
![optional ALT text](http://example.com/image.png)
Horizontal rules
Horizontal rules are lines that can be used as separators between lines of text. Add a horizontal rule using three or more asterisks or dashes.
*** 
---
Not supported in Self Service for macOS 10.0.0 or late
Ordered (numbered) lists
Indented, ordered list items can be added by starting a new line with a number, starting at 1, followed by a period and a space, and then the text for the list item.
Note:

An ordered list cannot be followed by an unordered list. All items will display as ordered.

1. My first ordered list item
2. My second ordered list item
3. My third ordered list item
Applicable to user-initiated enrollment, maintenance pages, and Self Service for macOS 10.0.0 or later only
Unordered (bulleted) lists
Indented, unordered list items can be added by starting a new line with either an asterisk or a dash, followed by a space, and then the text for the list item.
Note:

An unordered list cannot be followed by an ordered list. All items will display as unordered.

* My first unordered list item
* My second unordered list item
* My third unordered list item
- My first unordered list item
- My second unordered list item
- My third unordered list item
Applicable to user-initiated enrollment, maintenance pages, and Self Service for macOS 10.0.0 or later only
Tables
Tables can be added by inserting three or more hyphens (---) to create column headers and inserting a pipe ( | ) to create and separate columns. Rows can be added after the hyphens.
- My first unordered list item
- My second unordered list item
- My third unordered list item
In addition, you can align the text within the table by inserting a colon (:) to the left (align left), both sides (align center), or right (align right) to indicate the text justification for the text within the columns.
|Column Header 1 aligned left|Column Header 2 aligned center|Column Header 3 aligned right|
|:---|:---:|—:|
|my text will be aligned left|my text will be aligned center|my text will be aligned right|
|my text will be aligned left|my text will be aligned center|my text will be aligned right|
Applicable to Text PreStage Panes in Enrollment Customization for Jamf Pro 10.17.0 or later only
Embedded YouTube videos
Add an at (@) symbol, followed by brackets with optional helper text, and then the URL of the YouTube link in parentheses.
@[Jamf](https://www.youtube.com/watch?v=IetDCKhcP4E)
Note:

The URL must contain "https". In addition, the helper text within the brackets is optional, but the brackets are required.

Applicable to Text PreStage panes in Enrollment Customization for Jamf Pro 10.17.0 or later only