File: Snippets.md

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (45 lines) | stat: -rw-r--r-- 1,844 bytes parent folder | download
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
# Snippets

## Parsing

Parse strings in memory or files on disk into a structured ``Markup`` tree.

@Snippet(path: "swift-markdown/Snippets/Parsing/ParseDocumentString")
@Snippet(path: "swift-markdown/Snippets/Parsing/ParseDocumentFile")

## Querying

@Snippet(path: "swift-markdown/Snippets/Querying/ChildThrough")

## Walkers, Rewriters, and Visitors

Use ``MarkupWalker`` to collect information about ``Markup`` trees without modifying their contents.

@Snippet(path: "swift-markdown/Snippets/Walkers/LinkCollector")

Use ``MarkupRewriter`` to programmatically change the structure and contents of ``Markup`` trees.

@Snippet(path: "swift-markdown/Snippets/Rewriters/RemoveElementKind")
@Snippet(path: "swift-markdown/Snippets/Rewriters/ReplaceText")

Use ``MarkupVisitor`` to convert a ``Markup`` tree to another nested structure.

@Snippet(path: "swift-markdown/Snippets/Visitors/XMLConverter")

## Formatting

Use the following formatting options alone or in combination to format
a Markdown document to a consistent, preferred style.

@Snippet(path: "swift-markdown/Snippets/Formatting/DefaultFormatting")
@Snippet(path: "swift-markdown/Snippets/Formatting/MaximumWidth")
@Snippet(path: "swift-markdown/Snippets/Formatting/CondenseAutolinks")
@Snippet(path: "swift-markdown/Snippets/Formatting/CustomLinePrefix")
@Snippet(path: "swift-markdown/Snippets/Formatting/EmphasisMarkers")
@Snippet(path: "swift-markdown/Snippets/Formatting/OrderedListNumerals")
@Snippet(path: "swift-markdown/Snippets/Formatting/UnorderedListMarker")
@Snippet(path: "swift-markdown/Snippets/Formatting/PreferredHeadingStyle")
@Snippet(path: "swift-markdown/Snippets/Formatting/ThematicBreakCharacter")
@Snippet(path: "swift-markdown/Snippets/Formatting/UseCodeFence")

<!-- Copyright (c) 2022 Apple Inc and the Swift Project authors. All Rights Reserved. -->