Skip to main content
Jamf Nation, hosted by Jamf, is a knowledgeable community of Apple-focused admins and Jamf users. If you like what you see, join us in person at the ninth annual Jamf Nation User Conference (JNUC) this October for three days of learning, laughter and IT love.

Using Markdown to Format Text

Overview

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:

  • 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 Mobile, 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.

  • 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.

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

Supported Markdown Formatting

Formatting Markdown Syntax Notes
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. Examples:

# 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. Examples:

*my italicized text*
_my italicized text_

Strong (bold) text Use either double asterisks or double underscores around text to be bolded. Examples:

**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. Examples:

[my link text](http://example.com/)
[my link text](http://example.com/ "Optional help tag text")

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. Example:

![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. Examples:

*** 
---

Not supported in Self Service for macOS 10.0.0 or later
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.
Example:

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.
Examples:

* 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

Additional Information

For additional information, see the Jamf Pro Administrator's Guide.

Like Comment
Order by:
SOLVED Posted: by cdenesha

I notice that by default when I add a mobile device app to Self Service that it imports the app's current description into the Description field.

Am I correct in assuming that this text will never update on its own, i.e. when an app is updated on the App Store?

I'm thinking that we should customize the text for our environment, strip out the advertising, and perhaps update it occasionally with new features. Thoughts?

Thank you,

chris

Like
SOLVED Posted: by stwrz

Is there any way to change the text alignment on this page? I'd like for it to be left aligned.

Like
SOLVED Posted: by jhbush1973

Is there any update when ordered and numbered list will be available in Self Service descriptions?

Like
SOLVED Posted: by donmontalvo

This is awesome!

FYI, two line breaks will add a single line between paragraphs.

Don

Like
SOLVED Posted: by travismchugh

Any way to open a hyperlink from a Self Service description to a browser instead of in the Self Service window?

Like
SOLVED Posted: by donmontalvo

I know you mean the description, but if you want the item itself to open in a browser, Plug-in Type > Plug-in URL, then you'll see the option to "Open in browser".

Like
SOLVED Posted: by dhorsfall

After spending a whole lot of time trying to format a description in self service, I found another post that suggested two spaces (wasn't sure where) but after a bit of playing around putting two spaces in places, I found that by putting two spaces at the end of every line I was able to get just about all of the formatting I wanted to work!
(Thanks BTW whoever posted that advice!)
The "## Header 2" doesn't seem to want to work for me at all.

- Dan.

Like
SOLVED Posted: by donmontalvo

@jhbush1973 wrote:

Is there any update when ordered and numbered list will be available in Self Service descriptions?

Interesting, I wondered the same thing today. We are on 9.81 and are unable to create lists in Self Service.

Like
SOLVED Posted: by jhbush1973

@donmontalvo I don't think it's been addressed AFAIK. I'm running 9.82 in production.

Like
SOLVED Posted: by scottb

Still on 9.82, but had to create some new descriptions and don't see ## working either @dhorsfall.

Like
SOLVED Posted: by cshepp11

@donmontalvo Interestingly enough, if you put 2 spaces after each list line, it will work. I think @dhorsfall said something to this extent.

Like
SOLVED Posted: by rblaas

Hi All,

I am using markdown for the first time and I am having some trouble with it.

first point... My text is quite large... No Idea why

Second... I can't get it to work to have multiple lines. I did use the 2 spaces at the end of a line..

third.. I see some nicely sized windows.. How do you do that?

Thanks in advance

Regards Ronald

Like
SOLVED Posted: by cshepp11

@rblaas can you post a screenshot of the raw markdown from within the policy?

I can help to format it. Also, what version of jss are you running?

Like
SOLVED Posted: by rblaas

@cshepp11 this is what I got so far..

## This will perform some basic maintenance tasks

#### Tasks

##### * Fix Disk Permissions
##### * Fix ByHost Files
##### * Flush system Caches
##### * Flush User Caches

This results in:

But I want the task list without the lines in between.

Like
SOLVED Posted: by cshepp11

@rblaas I think it is having issues because you are trying to format each line as a heading. You could try to bold the text.

You could do something like this:

This will perform some basic maintenance tasks  

**Tasks Performed:**    
* **Fix Disk Permissions**   
* **Fix ByHost Files**   
* **Flush system Caches**   
* **Flush User Caches**

Which results in this:

and without bold:

Like
SOLVED Posted: by rblaas

@cshepp11 Many thanks! That works like a charm.

Like
SOLVED Posted: by denmoff

How might I escape a markdown character like the underscore? I thought a backslash would take care of it, but apparently it does not.

For instance, this:

This is some text with an underscore. Test\_Test\_Test.

Looks like this:

This is some text with an underscore. Test\Test|Test.

Like
SOLVED Posted: by L-plateAdmin

Good idea, just a real shame its limited to self service and not the User interactions messages..

Like
SOLVED Posted: by prbsparx

Seems like Markdown is extremely broken in Casper Suite 9.101...

Like