templates / Reference template
DocsTemplatesReference template

Reference template

Reference is looked up, not read top to bottom. Keep every entry in the same shape and keep it complete. Delete every template comment before committing.

1 min readTemplates
markdown
---
title: {{title}}
description: {{description}}
type: reference
since: {{since}}
---

<!-- template: reference is looked up, not read top to bottom. Keep every entry in the same shape and keep it complete. Delete every template comment before committing. -->

## Overview

One or two sentences on what this reference covers and where the values come from.

## Options

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `<name>` | `<type>` | `<default>` | <what it does> |

## Details

### `<name>`

What it does, accepted values and any interaction with other options.

```text
<example>
```

## Limits and notes

- <limit or caveat>

## See also

- [<Related reference>](./related.md)