File: TechnologyRoot.md

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • 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 (43 lines) | stat: -rw-r--r-- 969 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
36
37
38
39
40
41
42
43
 
# ``docc/TechnologyRoot``

Configures a documentation page that's not associated with a particular framework so it appears as a top-level page.

@Metadata {
    @DocumentationExtension(mergeBehavior: override)
}

## Overview

Place the `TechnologyRoot` directive within a `Metadata` directive to configure a documentation page that's not associated with a particular framework so it appears as a top-level page. Make sure the page includes a title, a summary line, an overview section, and a topics section with at least one topic group.

```
# Page Title

@Metadata {
   @TechnologyRoot
}

Summary line introducing the page.

## Overview

Add documentation here.

## Topics

### Topic Group Name

- ``APILink``
````

### Containing Elements

The following items can include a technology root element:

- ``Metadata``

## See Also

- <doc:formatting-your-documentation-content>

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