https://github.com/discourse/discourse-docs-card-filter

https://github.com/discourse/discourse-docs-card-filter

discourse-theme-component

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/discourse/discourse-docs-card-filter
• Owner: discourse
• License: mit
• Created: 2021-03-17T15:34:27.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T09:10:13.000Z (over 1 year ago)
• Last Synced: 2024-10-19T12:23:49.263Z (over 1 year ago)
• Topics: discourse-theme-component
• Language: JavaScript
• Homepage:
• Size: 461 KB
• Stars: 2
• Watchers: 22
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# discourse-docs-card-filter

This theme component is to be used with the [Discourse Docs Plugin](https://github.com/discourse/discourse-docs).

It will allow you to place "Cards" that act as a clickable filter for quicker filter results upon entering the `/docs` page by your users. 

![docs card filter preview](./readme-assets/preview.png)

These cards are rendered based on your selections in the settings of the `Docs` plugin.

The above would be rendered if in your docs plugin settings you have the following chosen:

![docs settings](./readme-assets/docs-settings.png)

## Component Settings

You can select custom icons for each category or tag card filter. You can also allow category descriptions to be rendered in the category card filters.

![card filter settings](./readme-assets/settings.png)