Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds breadcrumb navigation to the MkDocs Material-based docs site by enabling the navigation.path feature and rendering the corresponding template in the custom theme override.
Changes:
- Enabled the
navigation.pathfeature inmkdocs.yml. - Updated the theme override to conditionally include the Material breadcrumbs partial (
partials/path.html). - Added a small CSS tweak intended to align breadcrumb items, plus a minor formatting fix at the end of the stylesheet.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yml | Enables Material’s navigation.path feature to turn on breadcrumb support. |
| material-overrides/main.html | Renders breadcrumbs in the overridden layout when the feature is enabled. |
| material-overrides/assets/stylesheets/kluster.css | Adds breadcrumb-related styling adjustment and fixes indentation at EOF. |
Comments suppressed due to low confidence (2)
material-overrides/main.html:42
{% include "partials/path.html" %}depends on the upstream mkdocs-material template existing. If the build ever runs with a mkdocs-material version that predates breadcrumbs (or changes template paths), this will hard-fail at render time. Consider pinning/declaring a minimum mkdocs-material version that providesnavigation.path+partials/path.html, or vendoring an override copy ofpartials/path.htmlinmaterial-overrides/partials/to make the build resilient to upstream template changes.
{% if "navigation.path" in features %}
{% include "partials/path.html" %}
{% endif %}
mkdocs.yml:28
- Enabling
navigation.pathimplicitly requires a mkdocs-material version that supports that feature. Since dependencies aren’t pinned locally in this repo (requirements are pulled from a remote URL), a version mismatch could break the docs build unexpectedly. Suggest ensuring the remote requirements pin mkdocs-material to a compatible version (or documenting the minimum required version alongside this config change).
- navigation.path
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
eshaben
reviewed
Feb 24, 2026
Contributor
eshaben
left a comment
There was a problem hiding this comment.
can we remove home from the path? and can we add underlines to the links on hover, so it aligns with the usual hover style
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds breadcrumb navigation to improve site navigation
