The Swift Programming Language

This repository contains the source for The Swift Programming Language (sometimes abbreviated as TSPL), which is published on docs.swift.org and built using Swift-DocC.

Contributing

For small changes, like typo fixes and changes to a few paragraphs, fork this repository and make a pull request.

A formal contribution process for this document is still in development. In the meantime, start a pitch thread in the Swift forums for larger changes to discuss your approach and identify possible issues before you invest a lot of time in writing.

Content in this book follows Apple Style Guide and this book’s style guide.

File bugs about the content using the issues page on Github.

Discussions and contributions follow the Swift Code of Conduct.

For more information, see Contributing to The Swift Programming Language.

Building

Run docc preview TSPL.docc in this repository's root directory.

After running DocC, open the link that docc outputs to display a local preview in your browser.

Note:

If you installed DocC by downloading a toolchain from Swift.org, docc is located in usr/bin/, relative to the installation path of the toolchain. Make sure your shell's PATH environment variable includes that directory.

If you installed DocC by downloading Xcode, run xcrun docc preview TSPL.docc instead.