Markdown examples

This page exercises the guide's supported Markdown. The illustrations are test assets, not BetterDisplay screenshots. Use the breadcrumbs to return to the guide.

Text and emphasis

A paragraph with strong emphasis, emphasis, both together, deleted text and inline code. Underscores also work: strong and emphasis. A literal underscore in display_name stays intact.

This is a soft line break within the same paragraph.

These lines end with two spaces.
The next line is a hard break.
A backslash can create a hard break too.

Unicode: café, Csömör, 日本語, العربية, 1920 × 1080, ⌘ and 🙂.

Escaped punctuation: *literal asterisks*, [literal brackets], # not a heading and [[not-a-link]]. Entities: & < > © and a nonbreaking space.

Heading levels

Heading level three

Heading level four

Heading level five

Heading level six

The page title is level one and the main sections are level two.

Setext heading

Setext-style level-two headings also work. Heading links use GitHub-style IDs, including suffixes for duplicates.

Repeat

The first repeated heading.

Repeat

The second repeated heading. Jump to the first or the second.

Lists

• An unordered item.
• Another item with emphasis.
  • A nested item.
  • A nested wiki link.

1. Open the sample page.

2. Follow a breadcrumb.

   1. Visit the parent.
   2. Return with the browser's Back button.

3. Return to this page.

4. Ordered lists can start at another number.

5. The next item follows it.

• Checked task item.

• Unchecked task item.

  • Nested task item.

• A loose list item.

  A second paragraph inside the item.

  A blockquote inside a list.

• Another loose item.

Quotes and rules

A normal blockquote with formatted text.

A nested quote with a link to the guide.

A horizontal rule separates the following section.

GitHub alerts

Code and escaping

Inline code can contain a backtick: press ` once. It can also show literal ${display.name} and C:\Displays\Profiles.

let label = "Built-in Display"
print("Selected: \(label)")

printf '%s\n' '${DISPLAY_NAME}'
# Backticks and backslashes must survive authoring and export.
echo `hostname`

```text
[[guide]] is literal inside a code fence.
> [!WARNING]
This is example source, not an alert.
```

Tilde fences work too: ${value}, `backticks`, C:\Displays\Profiles.

Indented code keeps its spacing.
[[guide]] is not converted here.
> [!NOTE] stays literal.

A tab inside a code sample:

column one	column two

Tables

Links

• BetterDisplay Guide — an unlabelled wiki link uses the page title.
• Nested navigation — label first, target second.
• A heading on another page.
• This page's images.
• A conventional same-page heading link.
• BetterDisplay on GitHub.
• A reference-style project link.
• Autolink: https://github.com/waydabber/BetterDisplay.
• Bare URL: https://github.com/waydabber/BetterDisplay
• Email syntax: guide-test@example.invalid.
• Download a local text asset.

Images

Inline image syntax, with a title and descriptive alternative text:

A landscape display beside a portrait display, illustrated with simple shapes and colors.

A reference-style image:

The same display illustration, included using a Markdown image reference.

A linked image:

Select this display illustration to visit the BetterDisplay project on GitHub.

HTML and disclosures

Inline HTML: press ⌘ + F; H₂O; x²; highlighted text.

Footnotes

A statement with a footnote.¹ The same footnote can be referenced again.¹

Rendering boundaries

graph LR
  Guide --> Page

E = mc^2

Literal GitHub-specific text: #123, @example and :sparkles:.

Return to the guide or follow the navigation test.