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

Logo overlap in social card #6475

Closed
4 tasks done
ofek opened this issue Dec 10, 2023 · 18 comments
Closed
4 tasks done

Logo overlap in social card #6475

ofek opened this issue Dec 10, 2023 · 18 comments
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open

Comments

@ofek
Copy link
Sponsor Collaborator

ofek commented Dec 10, 2023

Context

No response

Bug description

When a custom logo is set, the site logo overrides it:

index

Related links

https://squidfunk.github.io/mkdocs-material/plugins/social/#option.logo

Reproduction

plugins:
  social:
    cards_layout_options:
      logo: docs/assets/images/logo.svg

Steps to reproduce

https://github.com/pypa/hatch/blob/master/mkdocs.yml

Browser

Chrome

Before submitting

@squidfunk
Copy link
Owner

Thanks for reporting. A mere mkdocs.yml is not a self-contained reproduction. Please carefully read our bug reporting guide again and provide a minimal reproduction by using the info plugin. Thank you.

@squidfunk squidfunk added the needs reproduction Issue lacks a minimal reproduction .zip file label Dec 10, 2023
@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

@squidfunk
Copy link
Owner

Thanks for the reproduction. So I read this only happens in Insiders?

@squidfunk
Copy link
Owner

Okay, this is still not a minimal reproduction. It contains your entire site. Please provide a minimal reproduction that only includes the minimal set of files that showcases the error. It's not runnable:

$ mkdocs build
ERROR   -  Config value 'markdown_extensions': Failed to load extension 'mkdocs-click'.
           ModuleNotFoundError: No module named 'mkdocs-click'
ERROR   -  Config value 'plugins': The "glightbox" plugin is not installed
ERROR   -  Config value 'watch': The path '/Users/squidfunk/Downloads/9.5.1+insiders.4.47.0-social-card-logo-overlap/backend/src/hatchling' isn't an existing file
           or directory.

@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

I thought that was an Insiders feature but I just installed the latest release instead and actually there is no overlap but rather the logo defined has no effect whatsoever and it uses the site logo only.

index

@squidfunk
Copy link
Owner

squidfunk commented Dec 10, 2023

So, does this solve your problem? I'm not sure I understand your last message... If not, we definitely need a minimal reproduction. Also note that the social plugin was entirely rewritten in Insiders. It has no commonalities with the community edition.

On a further note, logo is an Insiders feature, as mentioned in our documentation.

@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

Oh, indeed the option is insiders only which is why it has no effect on the latest public release https://squidfunk.github.io/mkdocs-material/plugins/social/#option.logo

Sure, I'll put together a small example. I literally just want that logo to be replaced by the path to image

@squidfunk
Copy link
Owner

squidfunk commented Dec 10, 2023

Thank you. Next time, you can save us both a lot of time providing the minimal reproduction when creating the issue. Please understand that we can make no exceptions, as we already invest a lot of time into providing free support.

@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

material-repro.zip

@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

I feel like this is such a fundamental feature and so simple that I must be doing something wrong in that example I just gave you. Do you think perhaps SVGs aren't supported for that field and maybe I should use a different format?

@squidfunk
Copy link
Owner

Is there any reason you are not using the info plugin as required? The info plugin collects all installed dependencies and information on the environment that is missing in your reproduction... You know, I'm happy to help you, but we have processes for a reason. I'm feeling really sorry to be so upfront, but having to ask for each and every bit of information is a very inefficient use of my time.

@squidfunk
Copy link
Owner

I can finally reproduce the error.

@squidfunk squidfunk added bug Issue reports a bug and removed needs reproduction Issue lacks a minimal reproduction .zip file labels Dec 10, 2023
@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

I'm sorry! I did the info plugin originally but you tried the archive and said it was not reproducible so I had to manually take away everything. Is that not what you meant for me to do?

@squidfunk
Copy link
Owner

A minimal reproduction should always be built from scratch, as described in our documentation.

@squidfunk
Copy link
Owner

squidfunk commented Dec 10, 2023

Fixed in 4aa87aa. It took 3min with a minimal reproduction 😉

index

@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Dec 10, 2023
@ofek
Copy link
Sponsor Collaborator Author

ofek commented Dec 10, 2023

I will do better with reproduction next time, thank you!

index

@ofek ofek closed this as completed Dec 10, 2023
@squidfunk squidfunk reopened this Dec 10, 2023
@squidfunk
Copy link
Owner

Keeping open until released.

@squidfunk
Copy link
Owner

Released as part of 9.5.2+insiders-4.47.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

2 participants