Parser extensions

MarkdownParsingOptions decides what the parser recognizes, not how it looks. An option that is off does not hide an element - it means the syntax was never an element in the first place. For the options that add new syntax, the markers then stay in the text as you typed them, so getting one wrong shows up as literal == or ^ in your output, not as an unstyled span. The two options that change an existing meaning fall back to the standard meaning instead.

import EnrichedMarkdown
import SwiftUI

struct ReleaseNotesView: View {
  let content: String

  var body: some View {
    EnrichedMarkdownText(content, options: MarkdownParsingOptions(underline: true, admonitions: true))
  }
}

Options are per view, and the default .commonMark turns everything off except permissiveAutolinks. Every element an option turns on has a renderer in the package, so enabling one never parses text into something that is then dropped. Outside SwiftUI the same struct goes to MarkdownRenderer.render(_:config:options:) and Parser.shared.parseMarkdown(_:options:) - see UIKit interop. This page walks through what each option changes and what it costs.

What is always on

Four things need no option and cannot be turned off:

• Tables, task lists, and strikethrough - the GFM set. Strikethrough takes both ~~struck~~ and, as GFM allows, a single ~struck~.
• Spoilers (||text||).

If a document uses paired ~ or || for something else, that is the one thing to know before rendering it.

Extensions that change an existing meaning

These two reassign characters Markdown already uses. They are the options worth being deliberate about.

underline

Makes _text_ and __text__ underlined instead of italic and bold.

MarkdownParsingOptions(underline: true)

The asterisk forms are untouched, so *italic* and **bold** keep working. But a document written by someone who used underscores for emphasis will come out underlined everywhere. Enable it for content you control - your own release notes, say - and leave it off for arbitrary Markdown from the internet.

Style it with the Underline() element.

subscript

Makes ~text~ lowered text.

MarkdownParsingOptions(subscript: true)

Without this option a single-tilde pair is strikethrough - ~struck~ renders struck, as in GFM. With it, the single form becomes subscript and only the doubled ~~struck~~ still strikes through. So the collision is with documents that already use single tildes for strikethrough: their struck text comes out lowered instead. A lone tilde with no closing partner - ~5 minutes - stays literal text either way.

Extensions that add new syntax

These four only add meaning to characters Markdown ignores today, so they are safe to enable on content you did not write.

superscript

^text^ renders raised. Sizing is a fraction of the surrounding text - see Superscript().

highlight

==text== renders with a background.

caution

The default highlight background is a fixed light yellow, and it does not adapt to dark mode. If you enable this option, set both a background and a foreground on Highlight() for every appearance you support, or a highlighted run will be unreadable in dark mode.

admonitions

A blockquote whose first line is > [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], or > [!CAUTION] renders as a callout with a tinted bar, an icon, and a title.

> [!TIP]
> Long-press a table to copy it as Markdown.

The marker is case-insensitive, so > [!note] works too. Without the option the marker is literal text on the first line of an ordinary quote - which is exactly what GitHub-flavored source will look like if you forget it. Colors come from Admonition().

preserveBlankLines

Keeps consecutive blank lines instead of collapsing them into a single paragraph break, so deliberate vertical whitespace in the source survives.

Extensions that change layout

hardSoftBreaks

Treats every single newline as a real line break instead of reflowing the paragraph.

MarkdownParsingOptions(hardSoftBreaks: true)

Reach for this whenever you render text a person typed - chat messages, notes, comments - where pressing Return is expected to produce a line break. Leave it off for authored documents, where reflowing is the point.

permissiveAutolinks

The one option that is on by default. It links bare URLs, www. hosts, and email addresses:

Read more at https://swmansion.com or write to hello@example.com.

With it off, only the angle-bracket form (<https://swmansion.com>) autolinks; a bare URL stays inert text. [text](url) is an ordinary inline link and works either way.

Turn it off when a document contains URL-shaped text that must not become tappable - a log excerpt, say, or user input you have not vetted.

import EnrichedMarkdown
import SwiftUI

struct CommentView: View {
  let userInput: String

  var body: some View {
    EnrichedMarkdownText(userInput, options: MarkdownParsingOptions(permissiveAutolinks: false))
  }
}

Math is not an option

$…$ and $$…$$ do not have a MarkdownParsingOptions field. Math parsing is switched on by the EnrichedMarkdownLaTeX product's .markdownLaTeX() modifier, which enables it and installs the renderer in one step - so it is impossible to parse math the base package cannot draw. Without the product, $x^2$ stays plain text.

Options travel with the copy

Copy as Markdown copies the selected slice of your original source, so markers come back exactly as typed - a partial selection out of an underline-enabled document keeps its _underline_ markers rather than being rebuilt as bold. The view remembers the options it rendered with and re-parses the slice with them to check it matches the selection; when it does not, the copy is rebuilt from the rendered text instead. Nothing to configure.

See also

• options - the reference entry for every field.
• Element structure - what each construct renders as once its option is on.
• LaTeX math - turning on $…$ and $$…$$.
• UIKit interop - passing options to MarkdownRenderer and Parser directly.