CommonMarkAttributedString
CommonMarkAttributedString is a Swift package that lets youcreate attributed strings using familiar CommonMark (Markdown) syntax.It's built on top of CommonMark,which is fully compliant with the CommonMark Spec.
Supported Platforms
- macOS 10.10+
- Mac Catalyst 13.0+
- iOS 9.0+
- tvOS 9.0+
Usage
import CommonMarkAttributedString
let commonmark = "A *bold* way to add __emphasis__ to your `code`"
let attributes: [NSAttributedString.Key: Any] = [
.font: NSFont.systemFont(ofSize: 24.0),
.foregroundColor: NSColor.systemBlue,
]
let attributedString = try NSAttributedString(commonmark: commonmark, attributes: attributes)
You can also use CommonMarkAttributedStringto create attributed strings that have multiple paragraphs,with links, headings, lists, and images.
let commonmark = #"""
# [Universal Declaration of Human Rights][uhdr]
## Article 1.
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.
[uhdr]: https://www.un.org/en/universal-declaration-human-rights/ "View full version"
"""#
let attributes: [NSAttributedString.Key: Any] = [
.font: NSFont.systemFont(ofSize: NSFont.systemFontSize),
.foregroundColor: NSColor.textColor,
.backgroundColor: NSColor.textBackgroundColor,
]
let attributedString = try NSAttributedString(commonmark: commonmark, attributes: attributes)
Supported CommonMark Elements
-
Code - Emphasis
- Link (inline links, link references, and autolinks)
- Strong
- > Block Quotes
- Headings
- Raw
<html>* - • Bulleted Lists *
- 1. Ordered Lists *
-
�� Images *
Raw Inline HTML
According to the CommonMark specification,each inline HTML tag is considered its own element.That is to say,CommonMark doesn't have a concept of opening or closing tags.So, for example,the CommonMark string <span style="color: red;">hello</span>corresponds to a paragraph block containing three inline elements:
Code(<span style="color: red;">)Text(hello)Code(</span>)
Parsing and rendering HTML is out of scope for this library,so whenever CommonMarkAttributedString receives text containing any HTML,it falls back on NSAttributedString's built-in HTML initializer.
Bulleted and Ordered Lists
CommonMarkAttributedString renders bulleted and ordered listsusing conventional indentation and markers ---disc (•), circle(◦), and square (■)for unordered listsanddecimal numerals (1.), lowercase roman numerals (i.), and lowercase letters (a.)for ordered lists.
- Level 1
- Level 2
- Level 3
- Level 2
- Level 1
- Level 2
- Level 3
- Level 2
Images
Attributed strings can embed images using the NSTextAttachment class.However,there's no built-in way to load images asynchronously.Rather than load images synchronously as they're encountered in CommonMark text,CommonMarkAttributedString provides an optional attachments parameterthat you can use to associate existing text attachmentswith image URL strings.
let commonmark = ""
let attachments: [String: NSTextAttachment] = [
"https://example.com/image.png": NSTextAttachment(data: <#...#>, ofType: "public.png")
]
let attributedString = try NSAttributedString(commonmark: commonmark, attributes: attributes, attachments: attachments)
Requirements
- Swift 5.1+
Installation
Swift Package Manager
Add the CommonMarkAttributedString package to your target dependencies in Package.swift:
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(
url: "https://github.com/mattt/CommonMarkAttributedString",
from: "0.2.0"
),
]
)
Then run the swift build command to build your project.
License
MIT
Contact
Mattt (@mattt)