Skip to content

Commit 7d54924

Browse files
author
Yuriy Kurant
authored
DEV: removes deprecated discourse-search-banner (#90)
As the part of the deprecation work of Advanced Search Banner theme component: https://meta.discourse.org/t/379322. * update the description of the theme * fix linked screenshots * update outdated screenshots * transition to a more light-weight `.webp` file type (~85% size reduction) * change images to follow 16:9 ratio * enhance description to be more specific and fine-grained
1 parent 67f68e4 commit 7d54924

15 files changed

+41
-36
lines changed

README.md

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,69 @@
1-
<!-- Describe this theme/component in one or two sentences -->
2-
3-
A clean & modern theme with a handful of theme-components included to enhance your forum!
4-
5-
<!-- Add screenshots (if applicable) -->
1+
A clean & modern theme with a couple of theme components included to enhance your forum!
62

73
**Light Mode**
84

9-
![image](https://user-images.githubusercontent.com/5862206/214545439-85410d82-9565-4e00-8b23-b2d69a0ee1eb.png)
5+
![light mode](screenshots/light.webp)
106

117
**Dark Mode**
128

13-
![image](https://user-images.githubusercontent.com/5862206/214545506-f44d6165-4f79-416e-a89c-548482d04cea.png)
9+
![dark mode](screenshots/dark.webp)
1410

1511
**Categories Page**
1612

17-
![image](https://user-images.githubusercontent.com/5862206/214545568-76d38925-55a6-4359-b1c6-bf1010706132.png)
18-
19-
This theme includes a handful of components to enhance your forum as well.
13+
![categories page](images/categories-page.webp)
2014

21-
- Dark Light Scheme Toggle
22-
- Clickable Topics
23-
- Discourse Loading Slider
24-
- Discourse Search Banner
25-
- Modern Category + Group Boxes
15+
This theme includes a couple of theme components to enhance your forum, as well:
2616

27-
> :exclamation: Please read through these tips upon installation, as there are a couple of settings that **NEED TO BE ENABLED** for this to theme to render properly.
17+
- [Clickable Topics](https://meta.discourse.org/t/clickable-topic/183339)
18+
- [Modern Category + Group Boxes](https://github.com/discourse/discourse-minimal-category-boxes)
2819

2920
---
3021

31-
# Tips
22+
## Theme configuration
3223

33-
### Dark Light Scheme Toggle
24+
> :exclamation: Please follow theme configuration tips upon installation, as there are a couple of settings that **NEED TO BE ENABLED** for this to theme to render properly.
3425
35-
![image](https://user-images.githubusercontent.com/5862206/214545622-af847fa5-b4ae-4308-9fe2-ddd66eb62cc8.png)
26+
### Dark Light Mode Toggle
3627

37-
For this to work properly, at least 2 color scheme choices need to be enabled in your `https://discourse.jordanvidrine.com/admin/customize/colors` area. At least two colors need to have `color scheme can be selected by users` enabled.
28+
![toggle dark light mode](images/toggle-dark-light-mode.webp)
3829

39-
![image](https://user-images.githubusercontent.com/5862206/214545647-e0544474-b6bf-4b9c-8c64-6a8bfa6ba83a.png)
30+
The mode toggle (image above) will be shown at the bottom of sidebar, once at least 2 color palette choices are enabled on the **Color palettes** admin page (`/admin/config/colors`). At least two colors need to have `Color palette can be selected by users` enabled:
4031

41-
Once this is done, users should be able to choose between two color schemes as their `light` and `dark` preferences in their user preferences interface menu.
32+
![color palettes](images/color-palettes.webp)
4233

43-
![image](https://user-images.githubusercontent.com/5862206/214545707-170a6b88-8ccd-4d31-af59-f0834a4fad3c.png)
34+
Once this is done, users should be able to choose between two color palettes as their `light` and `dark` preferences in their user preferences interface page (`/my/preferences/interface`):
4435

45-
---
36+
![user interface preferences](images/user-interface-preferences.webp)
4637

47-
## Discourse Search Banner
38+
### Edit Theme
4839

49-
In the options for the `discourse-search-banner` theme component, the `plugin-outlet` options needs to be set to **BELOW-SITE-HEADER** for this theme to render properly.
40+
Go to **Admin > Themes & components** (`/admin/config/customize/themes`) page to edit Air theme.
5041

51-
![image](https://user-images.githubusercontent.com/5862206/214545774-ed8f1322-9a95-4958-bba0-adf7ff6dea3f.png)
42+
- in **Dark color palette** dropdown select `air-dark`
5243

53-
---
44+
![theme dark color palette](/images/theme-dark-color-palette.webp)
45+
46+
## Welcome Banner
47+
48+
Go to **Admin > Welcome banner** (`/admin/config/welcome-banner`) page.
49+
50+
- in **Enabled on themes...** dropdown select `Air Theme`
51+
52+
![welcome banner themes](images/welcome-banner-enable.webp)
53+
54+
- in **Location** dropdown select `Below site header`
55+
56+
![welcome banner location setting](images/welcome-banner-location-setting.webp)
5457

5558
## Modern Category + Group Boxes
5659

57-
This theme component requires your categories to use the **CATEGORY BOXES WITH SUBCATEGORIES** setting in your `/admin/site_settings/category/all_results?filter=categories` area.
60+
Go to **Admin > Interface & layout** (`/admin/config/interface`) page.
61+
62+
- in **Desktop category page style** dropdown select `Boxes with Subcategories`
5863

59-
![image](https://user-images.githubusercontent.com/5862206/214545903-c4bd61b9-1893-48e0-84e7-502efc26c46d.png)
64+
![desktop category page style](images/desktop-category-page-style.webp)
6065

61-
This theme component also allows the forum admin to organize their category page with header titles, and choose which categories appear under each header. To keep things simple, I have only allowed up to 5 headings to be used. **If no categories + heading settings are chosen, all categories will render as they do above, this is the default rendering option.**
66+
This theme component allows the forum admin to organize their category page with header titles, and choose which categories appear under each header. To keep things simple, up to 5 headings are allowed to be used. **If no categories + heading settings are chosen, all categories will render as they do above, this is the default rendering option.**
6267

6368
---
6469

about.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "Air Theme",
3+
"authors": "Discourse",
34
"about_url": "https://meta.discourse.org/t/discourse-air-theme/197703",
45
"license_url": "https://github.com/discourse/discourse-air/blob/main/LICENSE",
56
"components": [
6-
"https://github.com/jordanvidrine/discourse-category-group-boxes.git",
7-
"https://github.com/discourse/discourse-clickable-topic.git",
8-
"https://github.com/discourse/discourse-search-banner.git"
7+
"https://github.com/discourse/discourse-minimal-category-boxes.git",
8+
"https://github.com/discourse/discourse-clickable-topic.git"
99
],
1010
"modifiers": {
1111
"serialize_topic_excerpts": true
@@ -39,5 +39,5 @@
3939
"hover": "535353"
4040
}
4141
},
42-
"screenshots": ["screenshots/light.png", "screenshots/dark.png"]
42+
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
4343
}

images/categories-page.webp

58 KB
Loading

images/color-palettes.webp

51.7 KB
Loading
22.7 KB
Loading
22.8 KB
Loading

images/toggle-dark-light-mode.webp

4.26 KB
Loading
54.2 KB
Loading

images/welcome-banner-enable.webp

23.4 KB
Loading
21.4 KB
Loading

0 commit comments

Comments
 (0)