--- name: swift-docc description: Official Swift DocC documentation markup and syntax reference --- # docc Produce rich API reference documentation and interactive tutorials for your Swift framework or package. ## Documentation Structure ### Essentials - **Documenting a Swift Framework or Package** ([documenting-a-swift-framework-or-package.md](documenting-a-swift-framework-or-package.md)): Create developer documentation from in-source comments, add articles with code snippets, ### Documentation Content - **Writing Symbol Documentation in Your Source Files** ([writing-symbol-documentation-in-your-source-files.md](writing-symbol-documentation-in-your-source-files.md)): Add reference documentation to your symbols that explains how to use them. - **Adding Supplemental Content to a Documentation Catalog** ([adding-supplemental-content-to-a-documentation-catalog.md](adding-supplemental-content-to-a-documentation-catalog.md)): Include articles and extension files to extend your source documentation comments or provide supporting conceptual content. - **Linking to Symbols and Other Content** ([linking-to-symbols-and-other-content.md](linking-to-symbols-and-other-content.md)): Facilitate navigation between pages using links. - **Adding Code Snippets to your Content** ([adding-code-snippets-to-your-content.md](adding-code-snippets-to-your-content.md)): Create and include code snippets to illustrate and provide examples of how to use your API. - **Documenting API with Different Language Representations** ([Documenting API with different language representations/documenting-api-with-different-language-representations.md](Documenting API with different language representations/documenting-api-with-different-language-representations.md)): Create documentation for API that's callable from more than one source language. ### Structure and Formatting - **Formatting Your Documentation Content** ([formatting-your-documentation-content.md](formatting-your-documentation-content.md)): Enhance your content's presentation with special formatting and styling for text and lists. - **Adding Tables of Data** ([adding-tables-of-data.md](adding-tables-of-data.md)): Arrange information into rows and columns. - **Other Formatting Options** ([other-formatting-options.md](other-formatting-options.md)): Improve the presentation and structure of your content by incorporating special page elements. - **Adding Images to Your Content** ([adding-images.md](adding-images.md)): Elevate your content's visual appeal by adding images. - **Adding Structure to Your Documentation Pages** ([adding-structure-to-your-documentation-pages.md](adding-structure-to-your-documentation-pages.md)): Make symbols easier to find by arranging them into groups and collections. - **Customizing the Appearance of Your Documentation Pages** ([customizing-the-appearance-of-your-documentation-pages.md](customizing-the-appearance-of-your-documentation-pages.md)): Customize the look and feel of your documentation webpages. ### Distribution - **Distributing Documentation to Other Developers** ([distributing-documentation-to-other-developers.md](distributing-documentation-to-other-developers.md)): Share your documentation by hosting it on a web server. ### Documentation Types - **API Documentation** ([Reference Syntax/API Reference Syntax/api-reference-syntax.md](Reference Syntax/API Reference Syntax/api-reference-syntax.md)): Teach your APIs through reference documentation you create from code comments and extension files, or create detailed articles and conceptual guides. - **Interactive Tutorials** ([Reference Syntax/Tutorials Syntax/tutorial-syntax.md](Reference Syntax/Tutorials Syntax/tutorial-syntax.md)): Teach developers your Swift APIs through step-by-step, interactive content. ### Shared Syntax ## Usage Notes - Documentation is organized progressively from getting started to advanced topics - Start with the Introduction or Getting Started section - Consult specific guides for detailed information ## License & Attribution This skill contains content converted from DocC documentation format.