swift-book-pdf 2.3.1

A tool to generate PDF and EPUB versions of The Swift Programming Language book.

PDF & EPUB Renderer for The Swift Programming Language

Convert the DocC source for The Swift Programming Language book into polished PDF and EPUB editions.

Jump to: Features · Installation · Usage · Customization · Wiki

Get the book

EPUB edition

The Swift Programming Language, optimized for Apple Books. Open in Apple Books ↗

PDF editions

For versioned archives of the PDF editions, see swift-book-archive.

Features

PDF Generation (swift-book-pdf)

• Generate a PDF edition of The Swift Programming Language, optimized for offline reading 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.

EPUB Generation (swift-book-epub)

• Generate an EPUB edition of The Swift Programming Language, ideal for e-readers and mobile devices.
• The generated EPUB file follows the rendering style used by TSPL editions up to Swift 5.7 published on Apple Books and retains all internal references and external links.

Requirements

• Python 3.10+
• Git
• Specifically for generating PDF editions with swift-book-pdf:
  • 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

PDF generation

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

EPUB generation

Call swift-book-epub without any arguments to save the resulting EPUB as swift_book.epub in the current directory.

$ swift-book-epub
[INFO]: Downloading TSPL files...
[INFO]: Creating EPUB...
[INFO]: EPUB saved to ./swift_book.epub

Customization

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

Acknowledgments

When you don't provide an input path, swift-book-pdf temporarily clones the swift-book repository for processing at runtime, 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.