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

Use the official Python logo #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

jonafato
Copy link

@jonafato jonafato commented Oct 29, 2024

Should this project use the official Python logo for the MkDocs theme logo and favicon? I've opened this as a quick PR instead of filing an issue because it's only a two line change.

Maintainers should please feel free to make edits to this PR or replace it with something else.

Commit message included below:


Use a custom logo for the theme's logo and favicon as documented in the Material for MkDocs documentation. This replaces the theme's default logo in the navbar and the favicon. The included logo is from the Python Developer's Guide, but other versions are available.

@hugovk
Copy link
Contributor

hugovk commented Oct 29, 2024

By default, the logo has a shadow beneath it, which causes the portrait rectangle to be squashed as a favicon:

image

Perhaps use the one at https://github.com/python/devguide/blob/main/_static/python-logo.svg instead, which has the shadow removed?

Use a custom logo for the theme's logo and favicon as documented in the
[Material for MkDocs documentation]. This replaces the theme's default
logo in the navbar and the favicon. The included logo is from the
[Python Developer's Guide], but other versions are available.

[Material for MkDocs documentation]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo
[Python Developer's Guide]: https://devguide.python.org/
@jonafato
Copy link
Author

@hugovk Thanks, I've updated my PR with your suggestion.

Contrast with the background is also a concern, and that is something that would require additional theme changes (i.e. the color of the header / navbar). I am not aware of brand guidelines regarding background colors, there's still room for improvement here.

@hugovk
Copy link
Contributor

hugovk commented Oct 29, 2024

Thanks, the favicon looks better:

image

Yeah, I see what you mean about the contrast between the "Blueberry Memories" header and the blue snake of the logo.

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