-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Add mkdocs.yml JSON schema support for sane_lists
and Neoteroi markdown extensions
#6381
Add mkdocs.yml JSON schema support for sane_lists
and Neoteroi markdown extensions
#6381
Conversation
Thanks! Could I please ask you to split the configuration similar to what we did for plugins here? The idea is to group external Markdown extensions that are not natively supported by Material for MkDocs under a dedicated group inside the schema. This makes it more clear what we support and what is supported through third parties. |
Sure, that makes perfect sense! Now that I see that the plugins schema already references some external schemas by URL, I might split the Neoteroi part of this PR off and submit it as a PR on their repo instead (and then change this PR accordingly). As for |
This allows the Markdown extensions provided by this MkDocs plugin to be included in the mkdocs.yml JSON schema definition maintained by the developers of mkdocs-material. See squidfunk/mkdocs-material#6381 and squidfunk/mkdocs-material#6378.
That would in fact be perfect and favorable over hosting the external schema here. In fact, we try only to host external schemas for extensions we mention on our docs, so this would be even better! |
This allows the Markdown extensions provided by this MkDocs plugin to be included in the mkdocs.yml JSON schema definition maintained by the developers of mkdocs-material. See squidfunk/mkdocs-material#6381 and squidfunk/mkdocs-material#6378.
Could you please split this PR into adding |
In fact, the Neoteroi maintainer has merged the PR already. I have updated this PR with the external URL accordingly. Happy to split this PR, if you'd prefer it for bookkeeping reasons, but otherwise it should be go to go as is. 👍🏻 |
Perfect, that was quick! No need to split into a separate PR – as it's already merged, all good. |
As suggested in #6378, this PR adds support for several markdown extensions to the JSON schema for
mkdocs.yml
:sane_lists
frompython-markdown
neoteroi-mkdocs
(I've added a separateexternal/
folder under the folder containing the schemas for markdown extensions - does that make sense?)