We begin the file with the name of the field. Next we write the field declaration and a short description of what the field does. Next we should attach an image or gif with it.
The second section is the Options
section marked by an h2
(##
) paragraph.
We should pass each option following this pattern:
<Option name="`OPTION_NAME_IN_CODE_BLOCK`">
Short description of the feature.
Code samples here.
Images here.
##### Default value
`THE_VALUE_IN_CODE_BLOCKS`
#### Possible values
Some possible values if they are known (`true`, `false`, `" "` `"on"`, `"off"`, etc.) or a text description about them.
</Option>
After the options, if the field has a lot of options and permutations and you'd like to show more, we can add an ## Examples
block.
Next are all the other things about the field. Maybe it requires some explanation
label
is optional.
<Demo link="https://avodemo.com" label="See the demo" />