Parameter and Expandable
Parameter renders the name/type/description row used throughout API reference content; Expandable wraps a nested set of them behind a “Show/Hide” toggle for a nested object’s own properties — the same pattern used on this site’s own OpenAPI-generated pages:
userUser Object
<Parameter name="user" type="User Object">
<Expandable title="properties">
<Parameter name="full_name" type="string">
The full name of the user
</Parameter>
<Parameter name="is_over_21" type="boolean">
Whether the user is over 21 years old
</Parameter>
</Expandable>
</Parameter>Every field table across this documentation (writedocs.json’s own configuration pages included) is written with Parameter rather than a plain Markdown table — the same reason it exists here: a name, an optional type badge, an optional “required”/“default” label, and a description that can hold more than a single table cell’s worth of prose.
Parameter props
namestringrequired
typestring
Omit to render with no type badge.
requiredboolean
Shows a red “required” label.
defaultstring
Shows a “default: …” label.
Expandable props
titlestringdefault: "properties"
defaultOpenbooleandefault: true