Interactive Tutorials

Overview

Use tutorials to deliver interactive documentation for your Swift frameworks and packages. Each tutorial augments your reference documentation by guiding readers through coding exercises that show how to build apps and projects that use your APIs in realistic ways.

[Image]

You write tutorial content in Markdown, and use directives to define specific types of pages and elements, like introductions, sections, steps, and assessments. Then, you run the DocC compiler to render your tutorial in a rich, interactive learning format.

[Image]

Topics

Essentials

• Building an Interactive Tutorial

Adding a Table of Contents

• Tutorials

Adding Tutorial Pages

• Tutorial
• Article

Shared Syntax

• Shared Directives

See Also

Documentation Types

• API Documentation