The swift-docc-static package
enables generating pure HTML/CSS documentation from Swift packages
that works locally as file:// URLs and can be hosted on any static web server.
The generated pages render without requiring JavaScript on the server or in the browser. The pages do offer filter and search functionality, though, if JavaScript is enabled.
Install using Homebrew:
brew tap mipalgu/tap
brew install swift-docc-static
Then generate documentation for your Swift package:
docc-static generate --package-path /path/to/package --output ./docs
open docs/index.html
The package provides a Swift Package Manager (SPM) plugin, a command-line utility, and a library for integration into other projects. You can find detailled documentation by clicking on the links below.
A command-line tool for generating static HTML/CSS documentation from Swift packages.
0 symbols
A Swift Package Manager plugin for generating static documentation using DocC.
3 symbols