Skip to content

Commit 6a36906

Browse files
Merge branch 'main' into fix/remove_ArgumentParser
2 parents cc99a57 + c570b58 commit 6a36906

File tree

7 files changed

+125
-0
lines changed

7 files changed

+125
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# ``Markdown``
2+
3+
Swift `Markdown` is a Swift package for parsing, building, editing, and analyzing Markdown documents.
4+
5+
## Overview
6+
7+
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.
8+
9+
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 Swift's [lib/Syntax](https://github.com/apple/swift/tree/master/lib/Syntax) and its Swift bindings, [SwiftSyntax](https://github.com/apple/swift-syntax).
10+
11+
## Topics
12+
13+
### Essentials
14+
15+
- ``Markup``
16+
- ``MarkupChildren``
17+
- ``ChildIndexPath``
18+
- ``TypedChildIndexPath``
19+
- ``DirectiveArgument``
20+
- ``DirectiveArgumentText``
21+
- ``Document``
22+
- ``LiteralMarkup``
23+
- ``PlainTextConvertibleMarkup``
24+
25+
### Markup Types
26+
27+
- <doc:BlockMarkup>
28+
- <doc:InlineMarkup>
29+
- ``Aside``
30+
31+
### Infrastructure
32+
33+
- <doc:Infrastructure>
34+
35+
### Visit Markup
36+
37+
- <doc:VisitMarkup>
38+
- <doc:FormatterAndOptions>
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Markup Block Nodes
2+
3+
## Topics
4+
5+
### Block Container Blocks
6+
- ``BlockDirective``
7+
- ``BlockQuote``
8+
- ``CustomBlock``
9+
- ``ListItem``
10+
- ``OrderedList``
11+
- ``UnorderedList``
12+
13+
### Inline Container Blocks
14+
- ``Paragraph``
15+
16+
### Leaf Blocks
17+
- ``Heading``
18+
- ``HTMLBlock``
19+
- ``ThematicBreak``
20+
- ``CodeBlock``
21+
22+
### Tables
23+
24+
- ``Table``
25+
- ``TableCellContainer``
26+
27+
## See Also
28+
- <doc:BlockDirectives>
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Formatter and Options
2+
3+
## Topics
4+
5+
### Formatter
6+
7+
- ``MarkupFormatter``
8+
9+
### Options
10+
11+
- ``MarkupDumpOptions``
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Infrastructure
2+
3+
## Topics
4+
5+
### Replacement
6+
7+
- ``Replacement``
8+
9+
### Source
10+
11+
- ``SourceLocation``
12+
- ``SourceRange``
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Markup Inline Nodes
2+
3+
## Topics
4+
5+
### Inline Container
6+
- ``Emphasis``
7+
- ``Image``
8+
- ``Link``
9+
- ``Strikethrough``
10+
- ``Strong``
11+
12+
### Inline Leaves
13+
- ``CustomInline``
14+
- ``InlineCode``
15+
- ``InlineHTML``
16+
- ``LineBreak``
17+
- ``SoftBreak``
18+
- ``SymbolLink``
19+
- ``Text``
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Visiting Markup
2+
3+
## Topics
4+
5+
### Vistor
6+
7+
- ``MarkupVisitor``
8+
9+
### Walker
10+
11+
``MarkupWalker`` is a default implementation for ``MarkupVisitor``.
12+
13+
- ``MarkupWalker``
14+
15+
### Rewriter
16+
17+
- ``MarkupRewriter``

0 commit comments

Comments
 (0)