Skip Navigation
Structure

Markdown

Property wrapper to turn any Markdown variable into HTML.
@propertyWrapper
struct Markdown

Overview

Basic usage.

struct Content {
    @Markdown var body: String
}


let content = Content(body: "# Hello")


// Automatic HTML conversion.
print(content.body) // "<h1>Hello</h1>"

Advanced usage.

struct Content {
    @Markdown(
        options: [.validateUTF8, .unsafe],
        extensions: [.strikethrough, .tasklist]
    ) var body: String
}


let content = Content(body: "# Hello")


// Automatic HTML conversion.
print(content.body) // "<h1>Hello</h1>"


// Retrieve the original Markdown.
print(content.$body) // "# Hello"

Topics

Initializers

init(wrappedValue: String, options: [CMarkOption]?, extensions: [GFMExtension]?)
Applies the Markdown conversion and saves the original value.

Instance Properties

var extensions: [GFMExtension]?
Custom GitHub Flavored Markdown (GFM) extensions.
var options: [CMarkOption]?
Custom CommonMark (CMark) options.
var projectedValue: String
Access the original value before conversion by prefixing the property name with $.
var wrappedValue: String
The HTML translation of the original Markdown value.

See Also

Converting Markdown to HTML

func toHTML(options: [CMarkOption], extensions: [GFMExtension]) -> String
Renders HTML code from the initial Markdown content.
Current page is Markdown