Class
TechnologyRoot
Configures an article to become a top-level page.
final class TechnologyRoot
Discussion
If your documentation only consists of articles, without any framework documentation or other top-level pages, DocC will use the only article or the article with the same base name as the documentation catalog (’.docc’ directory) as the top-level page. If the documentation doesn’t contain an article with the same base name as the documentation catalog, DocC will synthesize a minimal top-level page.
To customize which article is the top-level page of your documentation, add a TechnologyRoot directive within a Metadata directive in that article:
# Page Title
@Metadata {
@TechnologyRoot
}
Earlier Versions
Before Swift-DocC 6.0, article-only documentation catalogs require one of the articles to be marked as a TechnologyRoot.
Containing Elements
The following items can include a technology root element:
Topics
Instance Properties
Type Properties