Repository files navigation

Unidoc is a scalable documentation engine for the Swift language. Unidoc can be thought of as a multi-target analogue to Apple’s local DocC compiler. It is designed for long-lived, centralized documentation indices that store, link, and serve multiple versions of documentation for many Swift packages at once.

Unidoc powers theSwiftinit open source package index!

Unidoc supports Linux and macOS. Unidoc requires Swift 6.0.

We provide prebuilt binaries for the following platforms:

Follow ourquickstart guide to learn how to set up a local Unidoc server.

Unidoc supports theUCF symbol link syntax — a superset of the DocC symbol link syntax — which supportsmulti-component paths, cross-module references, and type signature disambiguation.

The Unidoc documentation compiler can be run in CI mode to validate documentation and fail the pipeline if documentation errors (such as broken links) are diagnosed.

The Unidoc compiler can diagnoseall broken symbol links, including references to symbols in package dependencies and the standard library.

We provide theswift-unidoc-action for GitHub Actions.

-name:Validate documentationrun:|        unidoc compile \            --swift-toolchain $SWIFT_INSTALLATION \            --ci fail-on-errors \            --project-path .

Unidoc can render SwiftPM code snippets in documentation with linked IDE-style code references and hover-over tooltips.

Seeswiftonserver.com, which uses Unidoc as its rendering backend, for an example of code snippets in action.

Unidoc servers are designed to store versioned documentation indefinitely. To achieve this, Unidoc uses a stable binary symbol graph format that can be up to two orders of magnitude smaller than an equivalent DocC archive.

Here’s a comparison for the (in)famousSwiftSyntax package, at version 508.0.1:

DocC numbers sourced from Slack

You can regenerate Unidoc documentation from symbol graph archives without recompiling documentation from package sources, which historically was amajor bottleneck in the DocC workflow. In many situations, this means you can easily upgrade Unidoc documentation to take advantage of new features even if the underlying symbol graph was compiled by an older version of Unidoc.

Unidoc databases use a cellular architecture which allows you to stagger documentation upgrades across a package index without taking the server offline.

Unidoc can validate and resolve cross-package symbol links, including links to symbols in the standard library. This means you can link toString in your documentation, and Unidoc will automatically generate a link to the standard library documentation forString.

Normal “IDE-style” symbol references, such as links toInt within function signatures, are also supported.

Unidoc can display extensions, including third-party extensions, directly in the documentation for the extended type. This means you can viewChannel members originating from packages such asswift-nio-ssl andswift-nio-http2 from theswift-nio documentation itself.

In the future, we hope to support finer-grained control over third-party extensions shown in extendee documentation.

Because Unidoc is a multi-package documentation engine, it can track and display symbols inherited from protocols in upstream dependencies, including the standard library, at negligible storage cost. This means types in third-party libraries that conform to protocols such asSequence can display and link toSequence API in their member lists.

Unidoc servers maintain a combined database of all documentation in their index. This allows Unidoc to serve (or redirect) individual symbol pages on-demand, instead of requiring clients to download enormous Vue.js indices for client-side rendering. This provides better performance for clients, and greatly reduces cache churn on the server as documentation is upgraded.

Unidoc generates lightweight HTML documentation that uses CSS for the majority of its layout and interactivity, and serves a very low number of additional assets. This means Unidoc pages are responsive, accessible, cache-friendly, and render with minimal content-layout shift (CLS).

Unidoc symbol graphs include line-breaking markers computed by SwiftSyntax, which allows Unidoc to display long function signatures in a readable, line-wrapped format. This makes it much easier to scan long lists of symbols with complex signatures, such as the member list of SwiftSyntax’sAccessPathComponentSyntax.

The Unidoc server can now query successors for symbols in older (and prerelease) versions, and display a banner directing visitors to the symbol’s counterpart in the latest stable release of its package. This link is specific to the symbol, and comes with a corresponding<link rel="canonical"> element and HTTP header.

Example:https://swiftinit.org/docs/swift-nio:2.57.0/niocore/eventloopgroup

Unidoc is able to serve symbol disambiguation pages under the300 Multiple Choice status code.

Although you should avoid creating ambiguous symbol links if possible, they are a natural occurrence as APIs evolve and overloads are added.

Example:https://swiftinit.org/docs/swift-certificates/x509/policyevaluationresult.failstomeetpolicy(reason:)

Unidoc can compute documentation coverage on a per-package and per-module basis. You can view coverage levels as pie-chart visualizations on package and module pages; seeswift-atomics’spackage page for an example.

Unidoc can periodically index Git tags by querying the GitHub API. This feature requires aGitHub app registration and app secret and is not enabled by default. Unidoc can also load repository metadata from GitHub, and use it to generate permanent links to source code on GitHub if the underlying symbol graph includes source map information.

The Unidoc compiler builds symbol graph archives with source maps by default, even if GitHub integration is not available.

When GitHub integration is available, Unidoc can usesocial authentication to allow users to log in with their GitHub account and perform administrative actions.

As theSwiftinit index grows, we hope to allow package maintainers to claim ownership of their packages and manage their documentation directly through the Swiftinit website.

Unidoc can generate, update, and serve sitemap files for search crawlers like Googlebot. This allows search engines to discover and index your documentation, and makes it easier for users to find your package.

Unidoc will make an effort to generate a<meta> description for every symbol in a package, even if the symbol has no documentation.

Unidoc avoids generating many copies of the same documentation, which can hinder visibility in search engines.