---
title: Metadata
framework: docc
role: symbol
role_heading: Directive
path: docc/metadata
---

# Metadata

Use metadata directives to instruct DocC how to build certain documentation files.

## Declaration

```swift
@Metadata {
    ...
}
```

## Overview

Overview Use the Metadata directive with other directives to configure how certain documentation files build. Place the directive after the documentation page’s title. Use it with the DocumentationExtension directive to replace in-source documentation with the documentation extension file’s content. # ``SlothCreator/Sloth``

@Metadata {     @DocumentationExtension(mergeBehavior: override) } Use the Metadata directive with the TechnologyRoot directive to customize which article is the top-level page for a documentation catalog (’.docc’ directory) without any framework documentation or other top-level pages. Use the Metadata directive with the DisplayName directive to configure a symbol’s documentation page to use a custom display name. # ``SlothCreator``

@Metadata {     @DisplayName("Sloth Creator") } Use the Metadata directive with the TitleHeading directive to configure the text of a page’s title heading. # ``SlothCreator``

@Metadata {     @TitleHeading("Release Notes") } Starting with version 6.0, use the Metadata directive with one or more Redirected directives to add additional URLs for a page. # ``SlothCreator``

@Metadata {     @Redirected(from: "old/path/to/page")     @Redirected(from: "another/old/path/to/page") } note: Starting with version 6.0, @Redirected is supported as a child directive of @Metadata. In previous versions, @Redirected must be used as a top level directive. Usage in documentation comments You can specify @Metadata configuration in documentation comments to specify Available directives. Other metadata directives are not supported in documentation comments. note: Don’t specify an @Metadata directive in both the symbol’s documentation comment and its documentation extension file. If you have one in each, DocC will pick the one in the documentation extension and discard the one in the documentation comment. note: Before Swift-DocC 6.1, @Metadata was not supported in documentation comments.

## Topics

### Extending or Overriding Source Documentation

- [DocumentationExtension](docc/documentationextension.md)

### Creating a Top-Level Technology Page

- [TechnologyRoot](docc/technologyroot.md)

### Customizing the Presentation of a Page

- [DisplayName](docc/displayname.md)
- [PageImage](docc/pageimage.md)
- [PageKind](docc/pagekind.md)
- [PageColor](docc/pagecolor.md)
- [CallToAction](docc/calltoaction.md)
- [TitleHeading](docc/titleheading.md)

### Customizing the Languages of an Article

- [SupportedLanguage](docc/supportedlanguage.md)
- [AlternateRepresentation](docc/alternaterepresentation.md)

### Customizing the Availability Information of a Page

- [Available](docc/available.md)
- [DeprecationSummary](docc/deprecationsummary.md)

### Specifying an Additional URL of a Page

- [Redirected](docc/redirected.md)

## See Also

### Configuring Documentation Behavior

- [Options](docc/options.md)
- [TechnologyRoot](docc/technologyroot.md)
- [Redirected](docc/redirected.md)