API field

Documented options and parameters for API reference pages.

<fd-api-field> documents one option, parameter or property. The description is the element's content, so inline code and links work inside it.

Example 

<fd-api-field name="sidebar_position" type="number" default="999">
  Sort order among sibling pages, ascending.
</fd-api-field>
<fd-api-field name="slug" type="string">
  Replaces the derived route. See <a href="./index.md">the overview</a>.
</fd-api-field>
<fd-api-field name="title" type="string" required>
  Page heading and browser title.
</fd-api-field>

Renders as:

Sort order among sibling pages, ascending. Replaces the derived route. See the overview. Page heading and browser title.

Attributes

The option's name, shown as code. Type annotation shown next to the name. Default value, shown as default: value. Adds a required badge. Present-as-attribute means true.