File: TitleHeading.md

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (35 lines) | stat: -rw-r--r-- 997 bytes parent folder | download 
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
 
# ``docc/TitleHeading``

A directive that specifies a title heading for a given documentation page.

@Metadata {
    @DocumentationExtension(mergeBehavior: override)
}

- Parameters:
    - heading: The text for the custom title heading.

## Overview

Place the `TitleHeading` directive within a `Metadata` directive to configure a documentation page to show a custom title heading. Custom title headings, along with custom [page icons](doc:PageImage) and [page colors](doc:PageColor), allow for the creation of custom kinds of pages beyond just articles.

A title heading is also known as a page eyebrow or kicker.

```
# ``SlothCreator``

@Metadata {
    @TitleHeading("Release Notes")
}
```

A custom title heading appears in place of the page kind at the top of the page.
### Containing Elements

The following items can include a title heading element:

@Links(visualStyle: list) {
   - ``Metadata``
}

<!-- Copyright (c) 2023 Apple Inc and the Swift Project authors. All Rights Reserved. -->