orcashub-discourse-theme/README.md

72 lines
3.9 KiB
Markdown
Raw 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|690x436, 75%](https://d11a6trkgmumsb.cloudfront.net/original/3X/5/2/52297fe2ab838db1902f6acbbbdee53d1271a840.png)
**Dark Mode**
![image|690x451, 75%](https://d11a6trkgmumsb.cloudfront.net/original/3X/7/b/7b592c6f1f901dce0ca9e9cbd01c8f2734847fe9.png)
**Categories Page**
![image|690x427, 75%](https://d11a6trkgmumsb.cloudfront.net/original/3X/b/d/bdb109def295c9954125124b9fc33be49d12e4f2.png)
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
2021-07-21 07:40:02 -07:00
![image|424x500, 50%](https://d11a6trkgmumsb.cloudfront.net/original/3X/1/e/1e498e5d1f26f6e46d09d48eabf7c7b6d291cd26.png)
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|690x207, 50%](https://d11a6trkgmumsb.cloudfront.net/original/3X/b/7/b70d149b335128a5f71914db3f703def1f48376b.png)
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|689x338, 50%](https://d11a6trkgmumsb.cloudfront.net/original/3X/1/8/184e79ce3851b9feb965117b68a97e5e7de00b93.png)
---
## 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|690x75, 75%](https://d11a6trkgmumsb.cloudfront.net/original/3X/a/c/acb30097e038fcdb3b2d77043237f46328ed8dd5.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|690x64, 75%](https://d11a6trkgmumsb.cloudfront.net/original/3X/c/2/c2798276e772741144c88c2ea47660b60bc3d4b5.png)
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) |