forked from discourse/discourse-topic-list-sidebars
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsettings.yml
50 lines (42 loc) · 2.24 KB
/
settings.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
setup:
type: list
default: "staff, 3"
setup_fixed:
type: list
default: "staff, 3"
description: |
Each line should be in the format of "<code>section name</code>, <code>post id</code>".<br/> (e.g., product-guides, 7441)<br/>
<ul>
<li>The section name is the name of the section you want to display in the sidebar</li>
<li>The post ID is the first number in its url, for from the url community.example.com/t/welcome-to-discourse/8/10, you would use <b>8</b> in the setting</li>
</ul>
setupDetails:
type: list
default: ""
description: |
Each line should be in the format of "<code>slug</code>, <code>ID</code>".<br/> (e.g., front-reliability, 719)<br/>
<ul>
<li>The slug is the slug name from its url, for example if your topic is located at community.marfeel.com/t/front-reliability/7141/14, you would use <b>front-reliability</b></li>
<li>The topic ID is the first number in its url, for from the url community.example.com/t/welcome-to-discourse/8/10, you would use <b>8</b> in the setting</li>
</ul>
<p>Note that for a user to be able to see the sidebar, they must be able to access the topic. A topic in a protected category will not be visible as a sidebar to all users. If you don't want a sidebar topic to appear in your topic details, you can unlist it.</p>
setup_by_category_id:
type: list
default: "58, 719"
description: |
Each line should be in the format of "<code>category id</code>, <code>ID</code>".<br/> (e.g., 58, 719)<br/>
<ul>
<li>The category id is the id from category url, for example if your category is located at community.marfeel.com/c/marfeel-docs/instrumentation/58, you would use <b>58</b></li>
<li>The topic ID is the first number in its url, for from the url community.example.com/t/welcome-to-discourse/8/10, you would use <b>8</b> in the setting</li>
</ul>
<p>Note that for a user to be able to see the sidebar, they must be able to access the topic. A topic in a protected category will not be visible as a sidebar to all users. If you don't want a sidebar topic to appear in your topic list, you can unlist it.</p>
sidebar_side:
default: left
type: enum
choices:
- left
- right
inherit_parent_sidebar:
default: true
stick_on_scroll:
default: true