mirror of
https://github.com/discourse/discourse-category-banners
synced 2025-02-13 15:04:49 +00:00
65 lines
1.7 KiB
YAML
65 lines
1.7 KiB
YAML
show_description:
|
|
default: true
|
|
description: 'Show description from "About This Category" post'
|
|
|
|
show_mobile:
|
|
default: true
|
|
description: "Show banners on mobile"
|
|
|
|
show_subcategory:
|
|
default: true
|
|
description: "Show banners for subcategories"
|
|
|
|
hide_if_no_description:
|
|
default: true
|
|
description: "Hide banners if category description is not set"
|
|
|
|
show_category_logo:
|
|
default: false
|
|
description: "Displays the category logo as set in the category's settings"
|
|
|
|
align_text:
|
|
default: center
|
|
type: "enum"
|
|
choices:
|
|
- center
|
|
- left
|
|
- right
|
|
|
|
exceptions:
|
|
default: ""
|
|
type: list
|
|
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>
|
|
|
|
plugin_outlet:
|
|
default: "below-site-header"
|
|
type: "enum"
|
|
choices:
|
|
- "below-site-header"
|
|
- "above-site-header"
|
|
- "above-main-container"
|
|
- "header-list-container-bottom"
|
|
description: "Changes the position of the banner on the page."
|
|
refresh: true
|
|
|
|
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>
|
|
|
|
override_category_icon_color:
|
|
default: false
|
|
description: When the category icons are used, enabling this will make the icon match the banner text color
|