Fields
Document parameters and configuration options with the Field component.
A <Field> documents one parameter — its name, type, whether it's required, and
a default. The children are the description. Adjacent fields are separated by
dividers, so a run of them reads as a parameter list.
namestringrequired
The site's name, shown as the header wordmark and the default page title.
colors.primarystringdefault: #dc143c
The accent color used for links, active navigation, and buttons.
velu.jsonfont.familystringGoogle Fonts
Any Google Font family name. Velu loads it and applies it as the body font.
<Field name="name" type="string" required>The site's name, shown as the header wordmark and the default page title.</Field><Field name="colors.primary" type="string" default="#dc143c">The accent color used for links, active navigation, and buttons.</Field><Field name="font.family" type="string" pre="velu.json" post="Google Fonts">Any Google Font family name.</Field>
Field properties
namestringrequired
The parameter or option name.
typestring
A type chip shown after the name, such as string or number.
requiredbooleandefault: false
Show a "required" pill.
defaultany
A default value, rendered as "default: value".
prestring
A chip shown before the name.
poststring
A trailing chip shown after the type.