DocC: Swift Documentation

In this article, you’ll learn about DocC, DocC Catalog, and creating/publishing documentation.

The DocC documentation compiler converts Markdown-based text into rich documentation for Swift frameworks and packages. You can preview the documentation in its published form as you work on it, and also host it on a website when it’s complete.

DocC is an open-source project. https://github.com/apple/swift-docc

Let’s move step by step.

DocC Catalog

DocC Catalog enables you to create three-page types: references, articles, and tutorials.

• Reference: Detailed documentation for classes, structs, or any code file.
• Articles: Provide an overview of how your framework or feature functions at a high level.
• Tutorials: Offering a step-by-step guide for using your framework or package.

DocC Catalog page types

Next you’ll learn how to create all these type of pages. But before let’s have a quick look on DocC and how we can documenting our existent code.

DocC