1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
public import Markdown
/// Configures an article to become a top-level page.
///
/// 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:
///
/// ```md
/// # 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:
///
/// - ``Metadata``
///
/// ## See Also
///
/// - <doc:formatting-your-documentation-content>
public final class TechnologyRoot: Semantic, AutomaticDirectiveConvertible {
public static let introducedVersion = "5.5"
public let originalMarkup: BlockDirective
static var keyPaths: [String : AnyKeyPath] = [:]
@available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
|
