Contents

init(markdown:options:baseURL:)

Creates an attributed string from Markdown-formatted data using the provided options.

Declaration

init(markdown: Data, options: AttributedString.MarkdownParsingOptions = .init(), baseURL: URL? = nil) throws

Parameters

  • markdown:

    The Data instance that contains the Markdown formatting.

  • options:

    Options that affect how the initializer interprets formatting in the Markdown string. This parameter defaults to no options.

  • baseURL:

    The base URL to use when resolving Markdown URLs. The initializer treats URLs as being relative to this URL. If this value is nil, the initializer doesn’t resolve URLs. The default is nil.

Discussion

If your source string includes custom attributes defined by conformers to MarkdownDecodableAttributedStringKey and used with Apple’s markdown extension syntax, be sure to include the allowsExtendedAttributes option. Otherwise, the initializer doesn’t parse these attributes.

See Also

Initializing from Markdown Data