Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/_help/documentation-experience/topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ x-topics:
```
```

## External references

You can write your topics in dedicated Markdown files to keep your OpenAPI definition file clean. To reference a Markdown file, add a `$ref` link inside the `content` object of your topic.

```yaml
x-topics:
- title: Getting started
content:
$ref: ./getting-started.md
- title: Authentication
content:
$ref: ./authentication.md
example:
$ref: ./authentication-example.md
```

## Public documentation examples

Here are some examples of public documentation made by teams using `x-topics`:
Expand Down