Include sidebar_class_name in category index metadata #10095
Labels
feature
This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
status: needs triage
This issue has not been triaged by maintainers
Have you read the Contributing Guidelines on issues?
Description
When I am using a folder for asset collection (ref) e.g.
I want the
sidebar_class_name
frontmatter to be included in the generated sidebar item -- the same as if I had not used a subfolder for asset collection.For clarity, I am not asking this be placed in the category metadata, which would apply to all child items of that category.
Has this been requested on Canny?
No
Motivation
I have a docusaurs site that utilizes
sidebar_class_name
for unique visual treatment (in this case, ADR statuses: draft, proposed, accepted, rejected, deprecated, ...). This works fine, until you have a document you place in a folder. Thensidebar_class_name
is not passed. The same problem exists when I tried_category_
.yml or .json withclassName
I found past issues that reference this same challenge:
className
does not work today)--
I debated if this was a bug or feature request, the documentation does state:
However, "Default Conventions" appears to only apply to how an index page for a category is identified. Not having anything to do with its metadata.
API design
No response
Have you tried building it?
No, primarily as I cannot determine if it's a feature gap or a bug. #6254 gives me the closest lead, but the resolution is not immediately clear to me.
Self-service
The text was updated successfully, but these errors were encountered: