discourse-category-banners/settings.yml

48 lines
1.3 KiB
YAML
Raw Normal View History

2020-09-24 15:44:49 -04:00
show_description:
2018-04-26 01:25:49 -04:00
default: true
description: 'Show description from "About This Category" post'
2020-09-24 15:44:49 -04:00
show_mobile:
2018-04-26 13:01:44 -04:00
default: true
2020-09-24 15:44:49 -04:00
description: "Show banners on mobile"
2018-04-26 13:01:44 -04:00
2020-09-24 15:44:49 -04:00
show_subcategory:
2018-04-26 13:01:44 -04:00
default: true
2020-09-24 15:44:49 -04:00
description: "Show banners for subcategories"
2018-04-26 13:01:44 -04:00
2020-09-24 15:44:49 -04:00
hide_if_no_description:
2018-04-26 14:01:28 -04:00
default: true
2020-09-24 15:44:49 -04:00
description: "Hide banners if category description is not set"
2018-04-26 13:01:44 -04:00
2018-04-26 01:25:49 -04:00
exceptions:
2018-04-26 13:01:44 -04:00
default: ""
2018-04-26 01:25:49 -04:00
type: list
2020-09-24 15:44:49 -04:00
list_type: simple
description: "Banner will not show for these category NAMES."
categories:
default: ""
type: list
description: |
Banner will only show for these categories. Format as <code>name:target</code> (e.g., <code>staff:all</code>).
Accepted targets:
<ul>
<li> all - named category and subcategories (default);
<li> no_sub - only the named category;
<li> only_sub - only subcategories of the named category.
</ul>
show_above_site_header:
default: false
type: bool
description: "Display the banner in the above site header connector."
show_below_site_header:
default: true
type: bool
description: "Display the banner in the below site header connector."
show_category_icon:
default: false
description: Show category icon from the <a href="https://meta.discourse.org/t/category-icons/104683" target="_blank">Discourse Category Icons component</a>