Mkdocs-material social plugin fails with hard to diagnose error on malformed yaml headers #5699
Closed
4 tasks done
Labels
change request
Issue requests a new feature or improvement
resolved
Issue is resolved, yet unreleased if open
Context
When trying to introduce tags into into a website rather than
the following header was introduced
Bug description
On a site with existing use of the social plugin the title field was accidentally replaced with a list e.g.
Due to the handling of yaml in python (by default) the last key entered will overwrite any previously duplicated key.
This scenario produces the traceback below when trying to run mkdocs-serve with either 9.18.1 or commit
580b0b9d0279b5eedde93636ea5e7f68ca11a117
.While there is an expected failure in this scenario the traceback makes it hard to trace the error:
in effect: the bug is a lack of logging sufficient for users to root cause the issue quickly. Only those comfortable with python can identify the issue then attempt to track down the source, if the change in a site is large.
Related links
Reproduction
Single page reproducer
testmkdocs-material-social.zip
Steps to reproduce
Browser
No response
Before submitting
The text was updated successfully, but these errors were encountered: