Skip to content

About

Find Swift packages, copy install commands, and read their API documentation.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

swift-library.github.io logo

swift-library.github.io

Find Swift packages, copy install commands, and read their API documentation.

CI License: Apache-2.0 WITH Swift-exception

Overview · Quick look · Install · Usage · Requirements · Documentation · Contributing · License

Overview

Read API docs for an installable release, with each package’s own landing-page identity intact. Repository descriptions and release links stay aligned with GitHub; the site guide covers catalog coverage, builds, preview, and deployment.

Quick look

Build and serve a local catalog:

Scripts/build-site --jobs 2
python3 -m http.server 8765 --bind 127.0.0.1 --directory _site

Install

Clone this repository to build or edit the site:

git clone https://github.com/swift-library/swift-library.github.io.git
cd swift-library.github.io

Visitors can browse the published catalog directly.

Usage

Edit catalog structure in projects.json and presentation in templates/ and assets/. Run Scripts/build-site, then Scripts/check-site; the development guide explains metadata inputs, DocC selection, caches, and preview checks.

Requirements

  • Python 3.12 or later and Git
  • macOS with Xcode, Swift, and DocC for package documentation builds
  • GitHub access through the existing GitHub CLI login or a workflow token

The Pages workflow declares the tested runner and Xcode selection.

Documentation

Contributing

See the contributing page and organization contribution guide. Run the checks in the site development guide before submitting changes.

License

The site uses Apache-2.0 WITH Swift-exception. The font retains its SIL Open Font License. See NOTICE for ownership.

About

Find Swift packages, copy install commands, and read their API documentation.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages