Skip Navigation
Structure

MarkdownString

Wrapper for strings containing Markdown code.
struct MarkdownString

Basic usage

let markdown = MarkdownString("# Hello")
let html = markdown.toHTML()
print(html) // "<h1>Hello</h1>"
print(markdown.description) // "# Hello"

Topics

Initializers

init(String)
Wraps up a String with Markdown inside.

Type Properties

static let defaultExtensions: [GFMExtension]
Default GFM extensions: GFMExtension.strikethrough, GFMExtension.autolink, GFMExtension.tagfilter.
static let defaultOptions: [CMarkOption]
Default CMark options: CMarkOption.githubPreLang, CMarkOption.tablePreferStyleAttributes.

Default Implementations

CustomStringConvertible Implementations

Relationships

Conforms To

  • Swift.Copyable
  • Swift.CustomStringConvertible
  • Swift.LosslessStringConvertible
  • Swift.Sendable
Current page is MarkdownString