Discourse Doc Categories

Love the plug in

Is it possible to add support to group headings into sections to help with layout. Something like H1 = Section header, H2 - group/folder header

I’ve tried to mock it up a little:

We are a makerspace with lots of Tool Areas, across different rooms. It would be great to have the Tool groups sectioned off by room

4 Likes

Could I use an external link here? And use _blank for open new tab?

You can start with an optional brief description of the category.

## Test external
* Google: https://google.com

## First section
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Short title: https://discourse.example.com/t/topic-with-a-long-title/56
* Another title: https://discourse.example.com/t/another-topic-with-a-long-title/78

## Second section
* Topic title: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
1 Like

Any unsupported installations will typically receive a link to unsupported installations. As a disclaimer as any issues could be in part related.

Plugins, themes, and theme components typically will have a file regarding version compatibility file

See below

Opening this file will give important version compat notes. Others may have it within the description. Ie Category Moderators enhance plugin has disclaimer of only supporting stable branch.

Pavilion gives recommended discourse update frequency to ensure they have time to update their add-ons.

2 Likes

Does this work for subcategories? I have a site with 6 core categories but want documentation for each category, as well as discussion. Not quite sure how best to achieve this.

It does. You can see it here in Documentation. The main category is basically a table of contents to the subcategories.

3 Likes

Just came across this and have a couple of questions please: How can we install it on our cloud-hosted site? And how much longer will the old Docs be around, do you think?

1 Like

We don’t have a timeline for completely removing the old plugin just yet, but it is no longer being actively developed. Once we have made some decisions about this, we’ll post an announcement about it to let everyone know!

Since this plugin is still experimental, it isn’t available on our hosting, but we’re currently discussing this internally and seeing if we can make this plugin available. We’ll circle back here once we have come to a conclusion there.

4 Likes

I’m gonna just add this for others who may find it confusing, like I was, what the plugin really does.

With all the settings, and the index topic, etc, it can feel overwhelming, on top of trying to understand what can be done, how it can be used, etc. At least, I was a bit confused until I figured out a way to understand it (if I’m missing something here, feel free to share it).

So basically the way I see it is: create your categories the way you want them and then this plugin just removes the default sidebar (with the sections for categories, tags, etc), and replaces it with a list of sections and links inside those sections to topics, categories, external links, etc. It’s just easier for me to look at it that way. It’s something more focused on customizing the sidebar when a particular category is visited. Something like: when category A is visited, replace the default sidebar with that custom sidebar provided by the index topic. Simple.

5 Likes

Feature Request:

Add support for “Discourse Icon” to render in Sidebar also bbcode color
& Emoji support.

2 Likes

This good suggestion would be better as a linked topic in Feature and tagged doc-categories

1 Like

Added thanks

1 Like