-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
Add breadcrumbs to docs #6096
Copy link
Copy link
Closed
Labels
featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.This is not a bug or issue with Docusausus, per se. It is a feature request for the future.status: accepting prThis issue has been accepted, and we are looking for community contributors to implement thisThis issue has been accepted, and we are looking for community contributors to implement this
Description
Metadata
Metadata
Assignees
Labels
featureThis is not a bug or issue with Docusausus, per se. It is a feature request for the future.This is not a bug or issue with Docusausus, per se. It is a feature request for the future.status: accepting prThis issue has been accepted, and we are looking for community contributors to implement thisThis issue has been accepted, and we are looking for community contributors to implement this
Type
Fields
Give feedbackNo fields configured for issues without a type.
Have you read the Contributing Guidelines on issues?
Description
Docs should have breadcrumbs in addition to sidebar.
Has this been requested on Canny?
No
Motivation
I've just built this feature for someone: PatelN123/Digital-Support-Notes#1 (That person just wanted the primary category, but I did extract the entire breadcrumb list)
It wasn't quite ergonomic, and I think it would make sense to make itself into the core.
API design
It would be opt-in, something like
showBreadcrumbsin the docs plugin. I think we can also set a metadata to help with SEO?If we don't want an opinionated implementation for the UI component, we can just implement a
useBreadCrumbsin theme-common and let users wrapDocItemto implement what they want.Have you tried building it?
Yes, see that PR for how I did it.
Self-service