https://github.com/swiftlang/swift-book

The Swift Programming Language book
https://github.com/swiftlang/swift-book

Last synced: 26 days ago
JSON representation

The Swift Programming Language book

• Host: GitHub
• URL: https://github.com/swiftlang/swift-book
• Owner: swiftlang
• License: apache-2.0
• Created: 2022-08-02T23:47:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-25T23:33:28.000Z (about 2 months ago)
• Last Synced: 2024-10-01T20:21:48.082Z (about 1 month ago)
• Language: Markdown
• Homepage:
• Size: 60.4 MB
• Stars: 1,735
• Watchers: 138
• Forks: 159
• Open Issues: 95
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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][published]

and built using [Swift-DocC][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][forum] 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][asg]

and [this book’s style guide][tspl-style].

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

Discussions and contributions follow the [Swift Code of Conduct][conduct].

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

[asg]: https://help.apple.com/applestyleguide/

[bugs]: https://github.com/apple/swift-book/issues

[conduct]: https://www.swift.org/code-of-conduct

[contributing]: /CONTRIBUTING.md

[forum]: https://forums.swift.org/c/swift-documentation/92

[tspl-style]: /Style.md

[published]: https://docs.swift.org/swift-book/documentation/the-swift-programming-language/

[docc]: https://github.com/apple/swift-docc

## 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.