PageKind
A directive that allows you to set a page’s kind, which affects its default title heading and page icon.
Declaration
@PageKind(_ kind: Kind)Parameters
- kind:
The page kind to apply to the page. (required)
articleAn article of free-form text; the default for standalone markdown files.
sampleCodeA page describing a “sample code” project.
Overview
The @PageKind directive tells Swift-DocC to treat a documentation page as a particular “kind”. This is used to determine the page’s default navigator icon, as well as the default title heading on the page itself.
The available page kinds are article and sampleCode.
This directive is only valid within a @Metadata directive:
@Metadata {
@PageKind(sampleCode)
}