This key defines the description text that appears on the Collection browser page.
Collection descriptions are useful for adding extra context for your team members.
CloudCannon supports a limited selection of Markdown formatting for the value of this key: links, bold, italic, subscript, superscript, and inline code.
This key has no default.
Appears in
└── collections_config
└── *
└── descriptionType
string
Examples
In this example, we have configured a description for the blog Collection with markdown formatting.
Copied to clipboard
collections_config:
blog: |-
description:|- This Collection is for *Travel blogs* and *Customer stories*.
If your have any questions, please contact Heather.{
"collections_config": {
"blog": "description:|- This Collection is for *Travel blogs* and *Customer stories*.\nIf your have any questions, please contact Heather."
}
}