Fix crash in social plugin and add support for logo in custom_dir#5447
Merged
squidfunk merged 3 commits intosquidfunk:masterfrom May 2, 2023
Merged
Fix crash in social plugin and add support for logo in custom_dir#5447squidfunk merged 3 commits intosquidfunk:masterfrom
squidfunk merged 3 commits intosquidfunk:masterfrom
Conversation
Owner
|
Thanks for the PR! I'll check it asap. Note that I'm currently working on a ground up rewrite of the social plugin which is close to being finished. The new version will fix all of those issues: custom icons can now be easily used, and even completely custom and parametrizable layouts (via front matter and Since this will be exclusive to sponsors at first, this PR has great value as it fixes those issues in the community edition as well. Thank you for taking the time! As said, please give me some time to check it thoroughly. |
Owner
|
Thanks again! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi 👋,
I've been working on adding social cards to our documentation, and I've encountered a few minor bugs, while doing so.
The crash was related to a valid, but partially incomplete
mkdocs.ymlconfiguration:I've fixed it in a way to handle both
font: falseandfont: {...}inputs, and it allows for the thetextkey to be missing.Fixes #4920
Fixes #5128
I've read both of those issues and I kind of disagree that the issue is unfixable with the current architecture or that fixing it would require adding flags, which could lead to code debt in the future. IMHO the behaviour of override asset paths taking priority over docs assets is expected and fully correct, therefore it's natural for the user to use this directory to store "shared" / "static" assets. This approach is frequently used with multilingual documentations, even the currently most popular guide uses this approach. Therefore I ask you to reconsider 🙏
I've added a custom_dir path lookup. If a given path exists in the overrides directory, then it's used to generate the logo.