Notes WWDC 2021 : Elevate your DocC documentation in Xcode
Mes notes pour la session Elevate your DocC documentation in Xcode de la WWDC 2021.
Page types
- Reference (code specific information)
- Articles (free-form content)
- Tutorials (step-by-step walkthrough)
Add “Documentation Catalog” to “Sources” folder
Images:
- Recommended to use @2x, with Dark Mode alternative
- Use
title~dark@2x.png
naming convention for files - Reference the basic file name in Markdown (

)
Organization
- Link to articles with
<doc:ArticleName>
- Link to symbols with double backtick
Extensions
Can put documentation in separate files, with same name (Foo.swift
and Foo.md
), and using the link syntax as title (# ``Foo``
)