mkdocs / mkdocs

Project documentation with Markdown.
https://www.mkdocs.org
BSD 2-Clause "Simplified" License
18.49k stars 2.36k forks source link

Remove jQuery dependency from mkdocs theme #3648

Closed oprypin closed 1 month ago

oprypin commented 1 month ago

Just as a reminder.

This is now easy to do, there are just some basic usages in base.js

as of Bootstrap version 5, jQuery was dropped as a dependency

squidfunk commented 1 month ago

Thanks for noting! Fixing this would close:

squidfunk commented 1 month ago

I've created a PR #3649 that removes jQuery from the mkdocs theme – feedback appreciated! If the PR would considered to be merged, I believe we could close this issue, as well as #2467.

tomchristie commented 1 month ago

Neat. 👍🏼

Custom theme overrides might be relying on this, so any migration notes/changelog would need to call it out clearly and show users exactly how to re-include it within their theme.

squidfunk commented 1 month ago

Jup, good catch. Users might have relied on jQuery being available. The question is if the maintainers of MkDocs consider customizations to be part of the public API, or an implementation detail. I'm leaning toward the latter, as it's not documented that jQuery is guaranteed to be available.

oprypin commented 1 month ago

https://github.com/mkdocs/mkdocs/pull/3631/commits/cc81c7013680b96c834bd292419f0013b74d7b35