☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

documentation

Table of contents

Description:

This key defines the documentation link at the top of a Collection browser.

Collection documentation is useful for assisting your team members.

Appears in:
├── collections_config
│   └── *
│       └── documentation
├── _inputs
│   └── *
│       ├── Text Input
│       │   └── documentation
│       ├── Textarea Input
│       │   └── documentation
│       ├── Code Input
│       │   └── documentation
│       ├── Color Input
│       │   └── documentation
│       ├── Boolean Input
│       │   └── documentation
│       ├── Number Input
│       │   └── documentation
│       ├── Range Input
│       │   └── documentation
│       ├── Rich Text Input
│       │   └── documentation
│       ├── Date/Datetime Input
│       │   └── documentation
│       ├── Time Input
│       │   └── documentation
│       ├── File Input
│       │   └── documentation
│       ├── URL Input
│       │   └── documentation
│       ├── Select Input
│       │   └── documentation
│       ├── Multiselect Input
│       │   └── documentation
│       ├── Choice Input
│       │   └── documentation
│       ├── Multichoice Input
│       │   └── documentation
│       ├── Object Input
│       │   ├── documentation
│       │   └── options
│       │       ├── entries
│       │       │   └── documentation
│       │       └── groups
│       │           └── [*]
│       │               └── documentation
│       └── Array Input
│           └── documentation
└── [*]
    ├── groups
    │   └── [*]
    │       └── documentation
    └── documentation
Type:
Object
Properties:
iconstring#

This key defines the icon for the documentation link at the top of a Collection browser.

Values can be from Google's Material Symbols library.

Defaults to: auto_stories

Allowed values: 123 360 10k 10mp 11mp 12mp 13mp 14mp 15mp 16mp and 3574 more.

Show examplesHide examples

In this example, we have configured the star icon for the blog Collection documentation link.

Copied to clipboard
collections_config:
  blog:
    documentation:
      url: https://www.cloudcannon.com/documentation/
      icon: star
{
  "collections_config": {
    "blog": {
      "documentation": {
        "url": "https://www.cloudcannon.com/documentation/",
        "icon": "star"
      }
    }
  }
}
textstring#

This key defines the link text for the documentation link at the top of a Collection browser.

Show examplesHide examples

In this example, the text for the documentation link is CloudCannon Documentation.

Copied to clipboard
collections_config:
  data:
    documentation:
      url: https://cloudcannon.com/documentation/
      text: CloudCannon Documentation
{
  "collections_config": {
    "data": {
      "documentation": {
        "url": "https://cloudcannon.com/documentation/",
        "text": "CloudCannon Documentation"
      }
    }
  }
}
urlstring Required#

This key defines the URL for the documentation link at the top of a Collection browser.

You must define this key for the documentation object to function.

This key has no default.

Show examplesHide examples

In this example, we have configured the blog Collection documentation link to go to example.com.

Copied to clipboard
collections_config:
  blog:
    documentation:
      url: https://example.com
{
  "collections_config": {
    "blog": {
      "documentation": {
        "url": "https://example.com"
      }
    }
  }
}
Examples:

In this example, the documentation link for the data Collection goes to CloudCannon Documentation.

Copied to clipboard
collections_config:
  data:
    documentation:
      url: https://cloudcannon.com/documentation/
      text: CloudCannon Documentation
      icon: star
{
  "collections_config": {
    "data": {
      "documentation": {
        "url": "https://cloudcannon.com/documentation/",
        "text": "CloudCannon Documentation",
        "icon": "star"
      }
    }
  }
}
Open in a new tab