diff --git a/Sources/Markdown/Markdown.docc/Markdown.md b/Sources/Markdown/Markdown.docc/Markdown.md new file mode 100644 index 00000000..bb68de67 --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown.md @@ -0,0 +1,38 @@ +# ``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 Swift's [lib/Syntax](https://github.com/apple/swift/tree/master/lib/Syntax) and its Swift bindings, [SwiftSyntax](https://github.com/apple/swift-syntax). + +## Topics + +### Essentials + +- ``Markup`` +- ``MarkupChildren`` +- ``ChildIndexPath`` +- ``TypedChildIndexPath`` +- ``DirectiveArgument`` +- ``DirectiveArgumentText`` +- ``Document`` +- ``LiteralMarkup`` +- ``PlainTextConvertibleMarkup`` + +### Markup Types + +- +- +- ``Aside`` + +### Infrastructure + +- + +### Visit Markup + +- +- diff --git a/Documentation/BlockDirectives.md b/Sources/Markdown/Markdown.docc/Markdown/BlockDirectives.md similarity index 100% rename from Documentation/BlockDirectives.md rename to Sources/Markdown/Markdown.docc/Markdown/BlockDirectives.md diff --git a/Sources/Markdown/Markdown.docc/Markdown/BlockMarkup.md b/Sources/Markdown/Markdown.docc/Markdown/BlockMarkup.md new file mode 100644 index 00000000..95272bdf --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown/BlockMarkup.md @@ -0,0 +1,28 @@ +# Markup Block Nodes + +## Topics + +### Block Container Blocks +- ``BlockDirective`` +- ``BlockQuote`` +- ``CustomBlock`` +- ``ListItem`` +- ``OrderedList`` +- ``UnorderedList`` + +### Inline Container Blocks +- ``Paragraph`` + +### Leaf Blocks +- ``Heading`` +- ``HTMLBlock`` +- ``ThematicBreak`` +- ``CodeBlock`` + +### Tables + +- ``Table`` +- ``TableCellContainer`` + +## See Also +- diff --git a/Sources/Markdown/Markdown.docc/Markdown/FormatterAndOptions.md b/Sources/Markdown/Markdown.docc/Markdown/FormatterAndOptions.md new file mode 100644 index 00000000..b9aaf08f --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown/FormatterAndOptions.md @@ -0,0 +1,11 @@ +# Formatter and Options + +## Topics + +### Formatter + +- ``MarkupFormatter`` + +### Options + +- ``MarkupDumpOptions`` diff --git a/Sources/Markdown/Markdown.docc/Markdown/Infrastructure.md b/Sources/Markdown/Markdown.docc/Markdown/Infrastructure.md new file mode 100644 index 00000000..03b9642d --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown/Infrastructure.md @@ -0,0 +1,12 @@ +# Infrastructure + +## Topics + +### Replacement + +- ``Replacement`` + +### Source + +- ``SourceLocation`` +- ``SourceRange`` diff --git a/Sources/Markdown/Markdown.docc/Markdown/InlineMarkup.md b/Sources/Markdown/Markdown.docc/Markdown/InlineMarkup.md new file mode 100644 index 00000000..b49bfd06 --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown/InlineMarkup.md @@ -0,0 +1,19 @@ +# Markup Inline Nodes + +## Topics + +### Inline Container +- ``Emphasis`` +- ``Image`` +- ``Link`` +- ``Strikethrough`` +- ``Strong`` + +### Inline Leaves +- ``CustomInline`` +- ``InlineCode`` +- ``InlineHTML`` +- ``LineBreak`` +- ``SoftBreak`` +- ``SymbolLink`` +- ``Text`` diff --git a/Sources/Markdown/Markdown.docc/Markdown/VisitMarkup.md b/Sources/Markdown/Markdown.docc/Markdown/VisitMarkup.md new file mode 100644 index 00000000..fda7c506 --- /dev/null +++ b/Sources/Markdown/Markdown.docc/Markdown/VisitMarkup.md @@ -0,0 +1,17 @@ +# Visiting Markup + +## Topics + +### Vistor + +- ``MarkupVisitor`` + +### Walker + +``MarkupWalker`` is a default implementation for ``MarkupVisitor``. + +- ``MarkupWalker`` + +### Rewriter + +- ``MarkupRewriter``