File tree 2 files changed +13
-1
lines changed
SwiftDocC/Semantics/Metadata
docc/DocCDocumentation.docc
2 files changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -23,6 +23,7 @@ import Markdown
23
23
/// - ``TechnologyRoot``
24
24
/// - ``DisplayName``
25
25
/// - ``PageImage``
26
+ /// - ``PageColor``
26
27
/// - ``CallToAction``
27
28
/// - ``Availability``
28
29
/// - ``PageKind``
Original file line number Diff line number Diff line change @@ -79,7 +79,8 @@ of a green hue.
79
79
80
80
As a general rule, the default color properties provided by DocC assumes a
81
81
naming convention where "fill" colors are used for backgrounds and "figure"
82
- colors are used for foreground colors, like text.
82
+ colors are used for foreground colors, like text. Note that colors defined in
83
+ ` theme-settings.json ` will be used across all pages of your documentation bundle.
83
84
84
85
> Tip:
85
86
> For a more complete example of a fully customized documentation website, you
@@ -239,6 +240,16 @@ be added as necessary for other features.
239
240
}
240
241
```
241
242
243
+ ### Customizing the appearance of specific pages
244
+
245
+ Aside from the customizations available via `theme-settings.json`, Swift DocC
246
+ provides several <doc :Metadata > directives that allow you to customize just
247
+ one specific Article page.
248
+
249
+ Most notably:
250
+ - ``PageImage`` allows you to set a header image of a page.
251
+ - ``PageColor`` allows you to set an accent color of a page.
252
+
242
253
[1]: https://github.com/apple/swift-docc/blob/main/Sources/SwiftDocC/SwiftDocC.docc/Resources/ThemeSettings.spec.json
243
254
[2]: https://drafts.csswg.org/css-variables/
244
255
[3]: https://mportiz08.github.io/swift-docc/documentation/docc
You can’t perform that action at this time.
0 commit comments