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) 2022-2023 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
import Markdown
/// A directive for specifying the style that should be used when rendering a page's
/// Topics section.
public class TopicsVisualStyle: Semantic, AutomaticDirectiveConvertible {
public static let introducedVersion = "5.8"
public let originalMarkup: BlockDirective
/// The specified style that should be used when rendering a page's Topics section.
@DirectiveArgumentWrapped(name: .unnamed)
public private(set) var style: Style
/// A visual style for a page's Topics section.
public enum Style: String, CaseIterable, DirectiveArgumentValueConvertible {
/// A list of the page's topics, including their full declaration and abstract.
case list
/// A grid of items based on the card image for each page.
///
/// Includes each page’s title and card image but excludes their abstracts.
case compactGrid
/// A grid of items based on the card image for each page.
///
/// Unlike ``compactGrid``, this style includes the abstract for each page.
case detailedGrid
/// Do not show child pages anywhere on the page.
case hidden
}
static var keyPaths: [String : AnyKeyPath] = [
"style" : \TopicsVisualStyle._style,
]
@available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
required init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
|
