swift-book-pdf 2.0.0

A tool to generate a PDF version of The Swift Programming Language book.

PDF Generator for The Swift Programming Language

Convert the DocC source for The Swift Programming Language book into a print-ready PDF document. The final document follows the DocC rendering style and retains all internal references and external links.

Preview Books (see swift-book-archive for versioned archives)
	Digital Mode Clickable links, best for on-screen reading	Print Mode Page numbers & full URLs, best for printing
Light Mode
Dark Mode

Features

• Generate a PDF version of the The Swift Programming Language book, perfect for offline browsing or printing.
• Choose from one of two rendering modes:
  • Digital mode with hyperlinks for cross-references between chapters and external links.
  • Print mode with page numbers accompanying cross-references between chapters and full URLs shown in footnotes for external links.
• Both versions follow the DocC rendering style used in docs.swift.org, including code highlighting.

Requirements

• Python 3.9+
• Git
• LuaTeX. If you don't have an existing LaTeX installation, see MacTeX, TeX Live, or MiKTeX.
• Fonts for typesetting. Learn which fonts are required to typeset the TSPL book.

Installation

Latest PyPI stable release

pip install swift-book-pdf

Usage

Basic usage

Call swift_book_pdf without any arguments to save the resulting PDF as swift_book.pdf in the current directory. The package defaults to the digital rendering mode in Letter paper size.

$ swift_book_pdf

[INFO]: Downloading TSPL files...
[INFO]: Creating PDF in digital (light) mode...
[INFO]: PDF saved to ./swift-book.pdf

When invoked, swift_book_pdf will:

1. Clone the swift-book repository
2. Convert all Markdown source files into a single LaTeX document
3. Render the LaTeX document into the final PDF document

[!NOTE] swift_book_pdf will create a temporary directory to store the swift-book repository, LaTeX file and intermediate files produced during typesetting. This temporary directory is removed after the PDF is generated.

Customization

swift-book-pdf offers a range of options to customize your rendering of The Swift Programming Language book. Learn how to make the TSPL book your own.

Acknowledgments

At runtime, the swift-book repository is temporarily cloned for processing, but no part of the repository is directly redistributed here.

chapter-icon.png and chapter-icon~dark.png are derived from the ArticleIcon.vue component in the swift-docc-render repository.

The swift-book and swift-docc-render repositories are part of the Swift.org open source project, which is licensed under the Apache License v2.0 with Runtime Library Exception. See https://swift.org/LICENSE.txt for more details. The Swift project authors are credited at https://swift.org/CONTRIBUTORS.txt.

The Swift logo is a trademark of Apple Inc.