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

Add mkdocs.yml JSON schema support for sane_lists and Neoteroi markdown extensions #6381

Merged
merged 2 commits into from
Nov 22, 2023

Conversation

AdrianoKF
Copy link
Contributor

As suggested in #6378, this PR adds support for several markdown extensions to the JSON schema for mkdocs.yml:

  • sane_lists from python-markdown
  • The Cards, Timeline, Gantt, and Spantable markdown extensions from neoteroi-mkdocs (I've added a separate external/ folder under the folder containing the schemas for markdown extensions - does that make sense?)

@squidfunk
Copy link
Owner

Thanks! Could I please ask you to split the configuration similar to what we did for plugins here?
https://github.com/squidfunk/mkdocs-material/blob/master/docs/schema/plugins.json

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.

@AdrianoKF
Copy link
Contributor Author

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 sane_lists, I would leave it in the current place, since it is part of the official python-markdown extensions (although not explicitly mentioned in the mkdocs-material docs)

AdrianoKF added a commit to AdrianoKF/neoteroi-mkdocs-plugins that referenced this pull request Nov 21, 2023
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.
@squidfunk
Copy link
Owner

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).

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!

@squidfunk squidfunk marked this pull request as draft November 21, 2023 15:33
RobertoPrevato pushed a commit to Neoteroi/mkdocs-plugins that referenced this pull request Nov 21, 2023
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.
@squidfunk
Copy link
Owner

squidfunk commented Nov 22, 2023

Could you please split this PR into adding sane_lists and the other extension? We can merge sane_lists right away, but we'll wait until the other schema has been added to the upstream repository.

@AdrianoKF
Copy link
Contributor Author

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. 👍🏻

@AdrianoKF AdrianoKF marked this pull request as ready for review November 22, 2023 07:10
@squidfunk
Copy link
Owner

Perfect, that was quick! No need to split into a separate PR – as it's already merged, all good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants