orcashub-discourse-theme/README.md

75 lines
3.8 KiB
Markdown
Raw Permalink Normal View History

2021-07-21 07:40:02 -07:00
<!-- Describe this theme/component in one or two sentences -->
A clean & modern theme with a handful of theme-components included to enhance your forum!
<!-- Add screenshots (if applicable) -->
**Light Mode**
![image](https://user-images.githubusercontent.com/5862206/214545439-85410d82-9565-4e00-8b23-b2d69a0ee1eb.png)
2021-07-21 07:40:02 -07:00
**Dark Mode**
![image](https://user-images.githubusercontent.com/5862206/214545506-f44d6165-4f79-416e-a89c-548482d04cea.png)
2021-07-21 07:40:02 -07:00
**Categories Page**
![image](https://user-images.githubusercontent.com/5862206/214545568-76d38925-55a6-4359-b1c6-bf1010706132.png)
2021-07-21 07:40:02 -07:00
This theme includes a handful of components to enhance your forum as well.
2021-07-21 07:40:02 -07:00
- Dark Light Scheme Toggle
- Clickable Topics
- Discourse Loading Slider
- Discourse Search Banner
- Modern Category + Group Boxes
> :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.
---
2021-07-21 07:40:02 -07:00
# Tips
2021-07-21 07:40:02 -07:00
### Dark Light Scheme Toggle
![image](https://user-images.githubusercontent.com/5862206/214545622-af847fa5-b4ae-4308-9fe2-ddd66eb62cc8.png)
2021-07-21 07:40:02 -07:00
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.
2021-07-21 07:40:02 -07:00
![image](https://user-images.githubusercontent.com/5862206/214545647-e0544474-b6bf-4b9c-8c64-6a8bfa6ba83a.png)
2021-07-21 07:40:02 -07:00
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.
![image](https://user-images.githubusercontent.com/5862206/214545707-170a6b88-8ccd-4d31-af59-f0834a4fad3c.png)
2021-07-21 07:40:02 -07:00
---
## Discourse Search Banner
2021-07-21 07:40:02 -07:00
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.
![image](https://user-images.githubusercontent.com/5862206/214545774-ed8f1322-9a95-4958-bba0-adf7ff6dea3f.png)
---
2021-07-21 07:40:02 -07:00
## Modern Category + Group Boxes
2021-07-21 07:40:02 -07:00
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.
![image](https://user-images.githubusercontent.com/5862206/214545903-c4bd61b9-1893-48e0-84e7-502efc26c46d.png)
2021-07-21 07:40:02 -07:00
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.**
---
Feel free to post any issues here :grinning_face_with_smiling_eyes:
2021-07-21 07:40:02 -07:00
I hope you enjoy!
| | | |
| ------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| :eyeglasses: | **Preview** | https://discourse.jordanvidrine.com/ |
| :hammer_and_wrench: | **Repository** | https://github.com/discourse/discourse-air.git |
| :question: | **Install Guide** | [How to install a theme or theme component](https://meta.discourse.org/t/how-do-i-install-a-theme-or-theme-component/63682) |
| :open_book: | **New to Discourse Themes?** | [Beginners guide to using Discourse Themes](https://meta.discourse.org/t/beginners-guide-to-using-discourse-themes/91966) |