Adding comments to your inputs in the data editor

You can add comments to your inputs  to add additional context for your editors. These will show up in the data editor when editing data files or front matter.

Comments are displayed for fields with the same keys as in the _comments object. Adding this object to your site’s configuration will apply the comments to all matching inputs throughout your site. Adding a _comments object to a page’s front matter will only apply the comments to that file.

  title: The page title
  output: Does this item have a dedicated page?
  brand_color: The primary brand color
  footer: Update the details in the footer

This will appear in the data editor as:

Screenshot of CloudCannon data editor with comments next to inputs
Was this article helpful? or Suggest an improvement >

Related articles