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

Bread-crumbs #355

Open
peekxc opened this issue Aug 6, 2024 · 1 comment
Open

Bread-crumbs #355

peekxc opened this issue Aug 6, 2024 · 1 comment
Labels
quarto .question Further information is requested

Comments

@peekxc
Copy link
Contributor

peekxc commented Aug 6, 2024

I'm having trouble generating bread-crumbs on a quartodoc-based site I'm working on.

Namely, setting the following option in the _quarto.yml file does nothing for me:

website:
  bread-crumbs: true

Interestingly, manually adding the option to the attribute at the top of each qmd page seems to work so long as the title is also included, e.g.

---
title: cover.set_cover_greedy
bread-crumbs: true
---
... // Note: normal H1 header needs to be removed here

According to the quarto docs, bread-crumb generation should be default behavior, yet they don't show in e.g. the vetiver docs even though they aren't specified. This leads to me to believe that maybe it's a quartodoc issue (it might be a quarto one though).

According to the docs:

By default, navigational breadcrumbs are displayed above the page title on each page that is nested deeper than one level in the sidebar navigation.

My sidebar.yml is quite uniform and meets the requirements I believe:

website:
  sidebar:
  - contents:
    - name: Geomcover
      href: ./index.qmd
    - section: Set Cover (`cover`)
      contents:
        - ./cover.coverage.qmd
        - ./cover.valid_cover.qmd
        - ./cover.set_cover_greedy.qmd
        - ./cover.set_cover_rr.qmd
        - ./cover.set_cover_ilp.qmd
        - ./cover.set_cover_sat.qmd
    - section: Linear Algebra (`linalg`)
      contents:
        - ./linalg.pca.qmd
        - ./linalg.cmds.qmd      
    - section: Geometry (`geometry`)
      contents:
        - ./geometry.tangent_bundle.qmd
        - ./geometry.bundle_weights.qmd
    - section: I/O (`io`)
      contents:
        - ./io.load_set_cover.qmd
        - ./io.to_canonical.qmd
        - ./io.sets_to_sparse.qmd
        - ./io.sparse_to_sets.qmd
        - ./io.reindex_sparse.qmd
    id: .
  - id: dummy-sidebar

(Here's my source code)

Expected behavior

For reference, here's what breadcrumbs look like when they show up

Screenshot 2024-08-05 at 4 44 31 PM

vs they don't:

Screenshot 2024-08-05 at 4 44 42 PM
@machow machow added this to quartodoc Aug 20, 2024
@machow
Copy link
Owner

machow commented Aug 20, 2024

Thanks for exploring -- I've opened an issue on quarto here, since it looks like quarto is requiring title: to be set in the top-matter:

quarto-dev/quarto-cli#10567

@machow machow added .question Further information is requested quarto labels Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quarto .question Further information is requested
Projects
Status: No status
Development

No branches or pull requests

2 participants