Support and Documentation

Most Brightspot themes have a large number of templates that address virtually all types of digital publishing. The following diagram shows a small subset of the templates available in the default theme.

If your Brightspot project uses only some of those templates, you can filter the unneeded ones using the key visibleExamples in the configuration file _config.json. This reduces the number of extraneous templates designers see in Styleguide. For example, if your Brightspot project only posts to social networks, you can filter the templates in Styleguide to only those associated with social networking.

The examples in the following sections use file globbing at the directory level; file globbing for template filtering is not available at the individual template level. For example, you can filter on templates matching the pattern /facebook/**/*, but not the pattern /facebook/**/OpenGraph*. See _hidden for information about hiding at the template level.

Filtering with a single glob

You can filter templates with a single glob within the theme's configuration file _config.json.

{
  "hiddenExamples": true, 1
  "visibleExamples": "/facebook/**/*" 2
}

1	Activates the filtering mechanism. This line is mandatory.
2	Filters for templates matching the file glob <template_directory>/styleguide/facebook/**/*.

The following illustration shows the result of the above filter.

{
  "hiddenExamples": true,
  "visibleExamples": [
    "/facebook/**/*",
    "/googleplus/**/*",
    "/twitter/**/*"
  ]
}

{
  "sources": [ 1
    {
      "source": "/styleguide", 2
      "hiddenExamples": true,
      "visibleExamples": "/facebook/**/*" 3
    }
  ]
}