Skip to content

Conversation

samiahmedsiddiqui
Copy link
Contributor

@samiahmedsiddiqui samiahmedsiddiqui commented Sep 29, 2022

@samiahmedsiddiqui
Copy link
Contributor Author

@chalin @LisaFC Please review.

@chalin
Copy link
Contributor

chalin commented Sep 29, 2022

Hi. Breadcrumbs can be hidden using CSS. We don't need another config option, IMHO. I'll comment more soon (not before next week).

@samiahmedsiddiqui
Copy link
Contributor Author

@chalin Let's suppose I have 2,000 docs pages and I want to hide breadcrumb on 200 pages. How can I do that?

@chalin
Copy link
Contributor

chalin commented Oct 7, 2022

@chalin Let's suppose I have 2,000 docs pages and I want to hide breadcrumb on 200 pages. How can I do that?

Hi @samiahmedsiddiqui. How would you do it within the scope of this PR? (I'm asking because it will better help me understand your use case, how you see it resolved, and whether there might be an alternative solution that is already available.)

@chalin chalin force-pushed the breadcrumbDisable branch from bb966ca to 248597a Compare October 7, 2022 20:51
@chalin chalin self-assigned this Oct 7, 2022
@samiahmedsiddiqui
Copy link
Contributor Author

@chalin I am doing this by defining another parameter in page. If you add breadcrumbDisable: true in the file then the breadcrumb will be disable for that particular page.

@samiahmedsiddiqui
Copy link
Contributor Author

@chalin Please review the PR.

@samiahmedsiddiqui samiahmedsiddiqui changed the title Hide Breadcrumb navigation on some docs pages Hide Breadcrumb navigation from particular pages not the entire website May 6, 2024
Copy link
Contributor

@fekete-robert fekete-robert left a comment

Choose a reason for hiding this comment

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

LGTM, but if it gets approved we should also mention that in the user guide.

@samiahmedsiddiqui
Copy link
Contributor Author

@chalin @fekete-robert Just wanted to nudge about the PR. Any chance we can get it merged soon?

@huanlin
Copy link
Contributor

huanlin commented Jul 26, 2024

Hey, I have tried the changes in my own docsy website, and after I see the result, I'm curious about when we need this feature.
Let me explain with an example:

Say I have a _index.md page with the following front matter:

---
title: How-tos
breadcrumbDisable: true
---

When I navigate to this "How-tos" page, the breadcrumb is not displayed. This part is OK.
Then I navigate to one of the child pages of this "How-tos" page, say "Apply for your API key", and this child page will display the breadcrumb like below:

My Docs / How-tos / Apply for your API key

So, the user can still see "How-tos" in the breadcrumb. This makes me curious: then why would we hide "How-tos" from the breadcrumb in the first place? After all, users can still see it from the child pages.

Hopefully I explain it clearly.

@samiahmedsiddiqui
Copy link
Contributor Author

@huanlin This pull request aims to selectively remove the breadcrumb navigation element from specific pages within the website, without affecting its display on other pages or child pages. As a concrete example, this change will prevent the breadcrumb from appearing on the Homepage, while still allowing it to be visible on all other pages, including those that link back to the Homepage as a parent.

@samiahmedsiddiqui
Copy link
Contributor Author

@chalin When can I expect this PR to be merged? I want this feature to be released so that I no longer need to update the templates.

@chalin
Copy link
Contributor

chalin commented Jan 8, 2025

For a proposed solution, see the following PR, which reuses the same config param name for both site and page/section-front-matter:

@chalin chalin closed this in #2161 Jan 10, 2025
@samiahmedsiddiqui samiahmedsiddiqui deleted the breadcrumbDisable branch January 13, 2025 07:24
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.

How hide breadcrumbs navigation on some docs pages ?
4 participants