Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Option to hide breadcrumbs #4875

Closed
4 tasks done
StarfallProjects opened this issue Jan 16, 2023 · 4 comments
Closed
4 tasks done

Option to hide breadcrumbs #4875

StarfallProjects opened this issue Jan 16, 2023 · 4 comments
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open

Comments

@StarfallProjects
Copy link
Sponsor Contributor

Contribution guidelines

I want to suggest an idea and checked that ...

  • ... to my best knowledge, my idea wouldn't break something for other users
  • ... the documentation does not mention anything about my idea
  • ... there are no open or closed issues that are related to my idea

Description

Breadcrumbs are awesome!

However, it would be good to be able to hide breadcrumbs on some pages. Ideally, two ways:

  • Hide on a page-by-page basis, in the same way as hiding the toc or navigation. This uses hide in frontmatter.
  • A setting in config to hide on all top level pages.

Use Cases

Breadcrumbs are awesome, but can look a bit odd on certain pages. In particular, the homepage. But also top-level pages where there isn't a path (so the breadcrumb just shows the page you're currently on - which is info you already have)

Screenshots / Mockups

No response

@squidfunk
Copy link
Owner

Added in f8261624e. Additionally, breadcrumbs will now only be rendered when there's more than one level. Everything else really makes no sense. However, if the author wishes to change this behaviour, the path.html partial can always be overridden and adjusted – theme extension as usual 😊 Syntax is

hide:
  - path

Give it a spin, then I'll add it to the documentation.

@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Jan 16, 2023
@squidfunk
Copy link
Owner

squidfunk commented Jan 17, 2023

Documentation added in b4c2ce4.

@squidfunk
Copy link
Owner

Released as part of 9.0.5-insiders-4.28.1.

@StarfallProjects
Copy link
Sponsor Contributor Author

Amazing thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

2 participants