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

Support mkdocs 1.4.2 and fix its missing breadcrumb #1691

Merged
merged 8 commits into from
Feb 25, 2023

Conversation

micahellison
Copy link
Member

@micahellison micahellison commented Feb 24, 2023

This PR upgrades us to mkdocs 1.4.2 and fixes the "missing" breadcrumb.

It turns out that the problem was a combination of issues:

  • a styling issue in jrnl's CSS with a class that's used multiple times for very different types of objects in the mkdocs ReadTheDocs template (sidebar logo and breadcrumb logo) - it turns out that "missing" breadcrumb was actually the white jrnl logo on a white background, using a CSS :before selector
  • a change in the mkdocs ReadTheDocs template's top-level breadcrumb link that was broke support for screen readers by removing the tag's content; RTD later fixed this with an aria-label but that hasn't made it into the mkdocs source

I'll see about getting that change upstream so we don't have to override their breadcrumbs template and others can benefit from this work, but in the meantime, this PR fixes it in jrnl so we can use the latest mkdocs version.

Checklist

  • I have read the contributing doc.
  • I have included a link to the relevant issue number.
  • I have checked to ensure there aren't other open pull requests
    for the same issue.
  • I have written new tests for these changes, as needed.

@micahellison micahellison added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Feb 24, 2023
@micahellison
Copy link
Member Author

Once this is fixed upstream, the breadcrumbs.html file can be deleted from docs_theme directory.

wren
wren previously approved these changes Feb 25, 2023
Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

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

Nice! Thank you! 💥

Copy link
Member

@wren wren left a comment

Choose a reason for hiding this comment

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

🥇

@wren wren merged commit d81b5ad into jrnl-org:develop Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants