Contact Us

Exhibits Documentation A guide to building exhibits using Spotlight

Advanced Formatting Using Markdown

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic and creating lists are a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

Syntax guide

Here’s an overview of Markdown syntax that you can use with the text widget on Spotlight. NOTE: This has not been tested fully in Spotlight yet, so some of the syntax may not work as expected. Some Spotlight widgets let you use Markdown; other Spotlight widgets don’t. You’ll have to experiment to see what works.

Headers

You can optionally add up to six levels of headings with Markdown (note H3 is the size in the widget header) :

Screen Shot 2019-06-03 at 5.42.12 PM.png

Emphasis (Bold/Italics)

Although you can generally format text in Spotlight using the context menu, as noted above, you can also add emphasis (bold or italics) using Markdown.

Screen Shot 2019-06-05 at 3.12.01 PM.png

Ordered Lists

To create an ordered list, type a number followed by a period and space at the start of the line, then type your text. When you get to the end of the line, use Shift + Enter to move to the next line, otherwise, you will be taken to a new widget window. Enter subsequent items for your list in the same way. Markdown will assign the appropriate numbers to your list, starting with number "1," no matter what numbers you enter; you can enter "22" for all of them and it will still number it properly. In the example below, all items have been entered with the number "1." To create a sub-item, type two spaces before the number. It works best to create ordered lists in their own text widget and not with any other text.

Screen Shot 2019-06-05 at 3.15.58 PM.png

Unordered Lists

To create an unordered list, type an asterisk, plus sign, or minus sign followed by a space at the start of the line, then type your text. When you get to the end of the line, use Shift + Enter to move to the next line, otherwise, you will be taken to a new widget window. Enter subsequent items for your list in the same way. To create a sub-item, type two spaces before the asterisk, plus sign, or minus sign. It works best to create unordered lists in their own text widget and not with any other text.

Screen Shot 2019-06-05 at 3.18.04 PM.png

Links

Although you can generally format hyperlinks in Spotlight using the context menu, as noted above, you can also format links using Markdown. First type the text you would like to be hyperlinked, enclosed in square brackets, and then after that text include the URL for the link, enclosed in parentheses or round brackets. It shouldn't matter whether there is a space between the text and the URL.

Screen Shot 2019-06-05 at 3.20.17 PM.png