Skip to content

Comments

Add Breadcrumbs#136

Open
0xlukem wants to merge 3 commits intomainfrom
0xlukem/breadcrumbs
Open

Add Breadcrumbs#136
0xlukem wants to merge 3 commits intomainfrom
0xlukem/breadcrumbs

Conversation

@0xlukem
Copy link
Contributor

@0xlukem 0xlukem commented Feb 23, 2026

This PR adds breadcrumb navigation to improve site navigation
image

Copilot AI review requested due to automatic review settings February 23, 2026 17:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.path feature in mkdocs.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 provides navigation.path + partials/path.html, or vendoring an override copy of partials/path.html in material-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.path implicitly 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.

@0xlukem 0xlukem requested a review from eshaben February 23, 2026 18:01
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants