1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# ``Markdown``
Swift `Markdown` is a Swift package for parsing, building, editing, and analyzing Markdown documents.
## Overview
The parser is powered by GitHub-flavored Markdown's [cmark-gfm](https://github.com/github/cmark-gfm) implementation, so it follows the spec closely. As the needs of the community change, the effective dialect implemented by this library may change.
The markup tree provided by this package is comprised of immutable/persistent, thread-safe, copy-on-write value types that only copy substructure that has changed. Other examples of the main strategy behind this library can be seen in [SwiftSyntax](https://github.com/apple/swift-syntax).
## Topics
### Snippets
A quick overview of examples showing tasks you can achieve with Swift Markdown.
- <doc:Snippets>
### Getting Started
- <doc:Parsing-Building-and-Modifying-Markup-Trees>
- <doc:Visitors-Walkers-and-Rewriters>
### Essentials
- ``Markup``
- ``MarkupChildren``
- ``ChildIndexPath``
- ``TypedChildIndexPath``
- ``DirectiveArgument``
- ``DirectiveArgumentText``
- ``Document``
- ``LiteralMarkup``
- ``PlainTextConvertibleMarkup``
### Markup Types
- <doc:BlockMarkup>
- <doc:InlineMarkup>
- ``Aside``
### Infrastructure
- <doc:Infrastructure>
### Visit Markup
- <doc:VisitMarkup>
- <doc:FormatterAndOptions>
<!-- Copyright (c) 2021-2022 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
