![]() |
Summary | Discourse Docs provides the ability to find and filter knowledge base topics |
![]() |
Repository Link | https://github.com/discourse/discourse-docs |
![]() |
Install Guide | How to install plugins in Discourse |
Features
The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. It’s a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
You can see it in action at https://meta.discourse.org/docs.
In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.
Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.
Need to find a knowledge base topic from somewhere else in Discourse? Use the new search helper: in:kb
.
Configuration
-
Enable the plugin by turning on the
docs enabled
setting. -
Add categories and tags to the
docs categories
anddocs tags
settings. -
Find the Docs link in the navigation menu.
- Profit with easier access to knowledge!
Settings
Name | Description |
---|---|
docs enabled | Enable the Docs Plugin |
docs categories | A list of category slugs to include in docs |
show tags by group | Organize tags using Tag Groups. Create groups to categorize related tags. |
docs tag groups | The Tag Groups used to show tags by group |
docs tags | A list of tags to include in docs |
docs add solved filter | Adds a filter for solved topics – requires Discourse Solved to be installed and enabled |
docs add to top menu | Adds a link to the top menu to navigate to the Docs view |
docs add search menu tip | Adds the tip “in:docs” to the search menu random tips |
Helpful Pairings
Development History
The Docs plugin was a continuation from the Knowledge Explorer Theme Component.
Hosted by us? This plugin is available on all of our hosting plans. Docs | Discourse - Civilized Discussion