Usage

import CommonMarkletmarkdown=#"""# [Universal Declaration of Human Rights][udhr]## Article 1.All human beings are born free and equal in dignity and rights.They are endowed with reason and conscienceand should act towards one another in a spirit of brotherhood.[udhr]: https://www.un.org/en/universal-declaration-human-rights/ "View full version""""#letdocument=tryDocument(markdown)

Inspecting Document Nodes

document.children.count // 3letheading= document.children[0]as!Headingheading.headerLevel // 1heading.children.count // 1letlink= heading.children[0]as!Linklink.urlString // "https://www.un.org/en/universal-declaration-human-rights/")link.title // "View full version"letsubheading= document.children[1]as!Headingsubheading.headerLevel // 2subheading.children.count // 1letsubheadingText= subheading.children[0]as!TextsubheadingText.literal // "Article 1."letparagraph= document.children[2]as!Paragraphparagraph.description // "All human beings [ ... ]"paragraph.range.lowerBound // (line: 5, column: 1)paragraph.range.upperBound // (line: 7, column: 62)

Rendering to HTML, XML, LaTeX, and Manpage

lethtml= document.render(format:.html) // <h1> [ ... ]letxml= document.render(format:.xml) // <?xml [ ... ]letlatex= document.render(format:.latex) // \section{ [ ... ]letmanpage= document.render(format:.manpage) // .SH [ ... ]// To get back CommonMark text, // you can either render with the `.commonmark` format...document.render(format:.commonmark) // # [Universal  [ ... ]// ...or call `description`// (individual nodes also return their CommonMark representation as their description)document.description // # [Universal  [ ... ]

Creating Documents From Scratch

Using Result Builders

import CommonMarkletdocument=Document{Heading{Link(urlString:"https://www.un.org/en/universal-declaration-human-rights/",                title:"View full version"){"Universal Declaration of Human Rights"}}Section{ // sections increase the level of contained headingsHeading{"Article 1."} // this is a second-level heading}    // block-level strings are parsed as CommonMark literals"""    **All** human beings are born free and equal in dignity and rights.    They are endowed with reason and conscience    and should act towards one another in a spirit of brotherhood."""}

Using the Conventional Approach

letlink=Link(urlString:"https://www.un.org/en/universal-declaration-human-rights/",                title:"View full version",                 text:"Universal Declaration of Human Rights")letheading=Heading(level:1, children:[link])letsubheading=Heading(level:2, text:"Article 1.")letparagraph=Paragraph(children:#"""All human beings are born free and equal in dignity and rights.They are endowed with reason and conscienceand should act towards one another in a spirit of brotherhood."""#.split(separator:"\n").flatMap{[Text(String($0)),SoftLineBreak()]})Document(children:[heading, subheading, paragraph]).description== document.description // true

CommonMark Spec Compliance

$swifttest Executed 649 tests, with 0 failures (0 unexpected) in 0.178 (0.201) seconds

Requirements

Installation

Swift Package Manager

import PackageDescriptionletpackage=Package(  name:"YourProject",  dependencies:[.package(        url:"https://github.com/SwiftDocOrg/CommonMark",        from:"0.5.1"),])

License

Contact