File tree Expand file tree Collapse file tree 1 file changed +13
-1
lines changed
Sources/docc/DocCDocumentation.docc Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -102,10 +102,22 @@ The `path` argument has three parts:
102
102
103
103
3 . The name of your snippet file without the ` .swift ` extension
104
104
105
- In the example package above, the ` YourProject.md ` file could reference ` example-snippet.swift ` like this:
105
+ In the example package above, the ` YourProject.md ` file might contain this markdown :
106
106
107
107
``` markdown
108
+ # ``YourProject``
109
+
110
+ Add a single sentence or sentence fragment, which DocC uses as the page’s abstract or summary.
111
+
112
+ ## Overview
113
+
114
+ Add one or more paragraphs that introduce your content overview.
115
+
116
+ This paragraph appears before the snippet.
117
+
108
118
@Snippet(path: "YourProject/Snippets/example-snippet")
119
+
120
+ This paragraph appears after the snippet.
109
121
```
110
122
111
123
Without any additional annotations in your snippet, Docc includes the entirety of your code example as the snippet.
You can’t perform that action at this time.
0 commit comments