Skip to content

Commit 6e31c34

Browse files
committed
README trailing spaces
1 parent 1d61565 commit 6e31c34

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Swift-DocC
22

3-
Swift-DocC is a documentation compiler for Swift frameworks and packages aimed
3+
Swift-DocC is a documentation compiler for Swift frameworks and packages aimed
44
at making it easy to write and publish great developer documentation.
55

6-
For an example of Swift-DocC in action, check out
6+
For an example of Swift-DocC in action, check out
77
[developer.apple.com](https://developer.apple.com/documentation).
88
Much of Apple's developer documentation,
99
from [Reference documentation](https://developer.apple.com/documentation/GroupActivities)
@@ -22,35 +22,35 @@ the best place to get help with Swift-DocC and discuss future plans.
2222

2323
## Writing and Publishing Documentation with Swift-DocC
2424

25-
If you're looking to write and publish documentation with Swift-DocC,
25+
If you're looking to write and publish documentation with Swift-DocC,
2626
the best way to get started is with Swift-DocC's
2727
[user documentation](https://www.swift.org/documentation/docc).
2828

2929
## Technical Overview and Related Projects
3030

31-
Swift-DocC builds documentation by combining _Symbol Graph_ files containing API information
31+
Swift-DocC builds documentation by combining _Symbol Graph_ files containing API information
3232
with a `.docc` Documentation Catalog containing articles and tutorials
3333
to create a final archive containing the compiled documentation.
3434

3535
More concretely, Swift-DocC understands the following kinds of inputs:
3636

3737
1. _Symbol Graph_ files with the `.symbols.json` extension.
38-
_Symbol Graph_ files are a machine-readable representation of a module's APIs,
38+
_Symbol Graph_ files are a machine-readable representation of a module's APIs,
3939
including their documentation comments and relationship with one another.
4040

41-
2. A Documentation Catalog with the `.docc` extension.
41+
2. A Documentation Catalog with the `.docc` extension.
4242
Documentation Catalogs can include additional documentation content like the following:
43-
43+
4444
- Documentation markup files with the `.md` extension. Documentation markup files can
4545
be used to extend documentation for symbols and to write free-form articles.
46-
46+
4747
- Tutorial files with the `.tutorial` extension. Tutorial files are used to author
4848
step-by-step instructions on how to use a framework.
49-
49+
5050
- Additional documentation assets with known extensions like `.png`, `.jpg`, `.mov`,
5151
and `.zip`.
52-
53-
- An `Info.plist` file containing metadata such as the name of the documented module.
52+
53+
- An `Info.plist` file containing metadata such as the name of the documented module.
5454
This file is optional and the information it contains can be passed via the command line.
5555

5656
Swift-DocC outputs a machine-readable archive of the compiled documentation.
@@ -66,27 +66,27 @@ project's technical documentation:
6666

6767
### Related Projects
6868

69-
- As of Swift 5.5, the [Swift Compiler](https://github.com/apple/swift) is able to
69+
- As of Swift 5.5, the [Swift Compiler](https://github.com/apple/swift) is able to
7070
emit _Symbol Graph_ files as part of the compilation process.
71-
71+
7272
- [SymbolKit](https://github.com/apple/swift-docc-symbolkit) is a Swift package containing
7373
the specification and reference model for the _Symbol Graph_ File Format.
74-
75-
- [Swift Markdown](https://github.com/apple/swift-markdown) is a
76-
Swift package for parsing, building, editing, and analyzing
74+
75+
- [Swift Markdown](https://github.com/apple/swift-markdown) is a
76+
Swift package for parsing, building, editing, and analyzing
7777
Markdown documents. It includes support for the Block Directive elements
7878
that Swift-DocC's tutorial files rely on.
79-
80-
- [Swift-DocC-Render](https://github.com/apple/swift-docc-render)
79+
80+
- [Swift-DocC-Render](https://github.com/apple/swift-docc-render)
8181
is a web application that understands and renders
8282
Swift-DocC's _render JSON_ format.
83-
83+
8484
- [Xcode](https://developer.apple.com/xcode/) consists of a suite of
8585
tools that developers use to build apps for Apple platforms.
8686
Beginning with Xcode 13, Swift-DocC is integrated into Xcode
8787
with support for building and viewing documentation for your framework and
8888
its dependencies.
89-
89+
9090
## Getting started with developing `docc`
9191

9292
`docc` is the command line interface (CLI) for Swift-DocC and provides
@@ -128,17 +128,17 @@ To run `docc`, run the following command:
128128
```bash
129129
swift run docc
130130
```
131-
131+
132132
### Installing into Xcode
133133

134134
You can test a locally built version of Swift-DocC in Xcode 13 or later by setting
135135
the `DOCC_EXEC` build setting to the path of your local `docc`:
136136

137137
1. Select the project in the Project Navigator.
138-
139-
2. In the Build Settings tab, click '+' and then 'Add User-Defined Setting'.
140-
141-
3. Create a build setting `DOCC_EXEC` with the value set to `/path/to/docc`.
138+
139+
2. In the Build Settings tab, click '+' and then 'Add User-Defined Setting'.
140+
141+
3. Create a build setting `DOCC_EXEC` with the value set to `/path/to/docc`.
142142

143143
The next time you invoke a documentation build with the "Build Documentation"
144144
button in Xcode's Product menu, your custom `docc` will be used for the build.
@@ -160,19 +160,19 @@ the path you provded if it's set.
160160
## Using `docc` to build and preview documentation
161161
162162
The preferred way of building documentation for your Swift package is by using
163-
the Swift-DocC Plugin, or if you're using Xcode, using the "Build Documentation" command.
163+
the Swift-DocC Plugin, or if you're using Xcode, using the "Build Documentation" command.
164164

165-
Refer to instructions in the plugin's
165+
Refer to instructions in the plugin's
166166
[documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
167167
to get started with [building](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-a-specific-target), [previewing](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation),
168168
and publishing your documentation to your [website](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online) or [GitHub Pages](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages).
169169
170-
Alternatively, you can manually generate symbol graph files and invoke `docc` directly.
170+
Alternatively, you can manually generate symbol graph files and invoke `docc` directly.
171171
Refer to instructions in [CONTRIBUTING.md](/CONTRIBUTING.md#assembling-symbol-graphs-and-building-with-docc-directly).
172-
172+
173173
## Versioning
174174
175-
Swift-DocC's CLI tool (`docc`) will be integrated into the Swift toolchain
175+
Swift-DocC's CLI tool (`docc`) will be integrated into the Swift toolchain
176176
and follows the Swift compiler's versioning scheme.
177177
178178
The `SwiftDocC` library is versioned separately from `docc`. `SwiftDocC` is under
@@ -182,7 +182,7 @@ active development and source stability is not guaranteed.
182182
183183
### Submitting a Bug Report
184184
185-
Swift-DocC tracks all bug reports with
185+
Swift-DocC tracks all bug reports with
186186
[GitHub Issues](https://github.com/apple/swift-docc/issues).
187187
When you submit a bug report we ask that you follow the
188188
[provided template](https://github.com/apple/swift-docc/issues/new?assignees=&labels=bug&template=BUG_REPORT.yml)
@@ -191,7 +191,7 @@ and provide as many details as possible.
191191
> **Note:** You can use the [`environment`](bin/environment) script
192192
> in this repository to gather helpful environment information to paste
193193
> into your bug report by running the following:
194-
>
194+
>
195195
> ```sh
196196
> bin/environment
197197
> ```

0 commit comments

Comments
 (0)