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

YAML schema missing markdown extensions #6378

Closed
4 tasks done
AdrianoKF opened this issue Nov 21, 2023 · 2 comments
Closed
4 tasks done

YAML schema missing markdown extensions #6378

AdrianoKF opened this issue Nov 21, 2023 · 2 comments

Comments

@AdrianoKF
Copy link
Contributor

Context

No response

Bug description

The JSON schema definition for the mkdocs.yml format does not recognize a couple of Markdown extensions:

I can prepare a PR adding the relevant plugins to the schema (however, I might be missing others that I haven't run into just yet).

Related links

Reproduction

Not including, since this is not an issue with a generated site.

Steps to reproduce

Here's a snippet from my mkdocs.yml, both lines trigger an error message saying the value is not accepted in VSCode:

markdown_extensions:
  - neoteroi.cards  # https://www.neoteroi.dev/mkdocs-plugins/cards/
  - sane_lists

Full error message:

Value is not accepted. Valid values: "markdown.extensions.abbr", "abbr", "markdown.extensions.admonition", "admonition", "markdown.extensions.attr_list", "attr_list", "markdown.extensions.callouts", "callouts", "markdown.extensions.def_list", "def_list", "markdown.extensions.footnotes", "footnotes", "markdown.extensions.md_in_html", "md_in_html", "markdown.extensions.tables", "tables", "markdown.extensions.toc", "toc", "pymdownx.arithmatex", "pymdownx.betterem", "pymdownx.caret", "pymdownx.critic", "pymdownx.details", "pymdownx.emoji", "pymdownx.highlight", "pymdownx.inlinehilite", "pymdownx.keys", "pymdownx.magiclink", "pymdownx.mark", "pymdownx.smartsymbols", "pymdownx.snippets", "pymdownx.superfences", "pymdownx.tasklist", "pymdownx.tilde".yaml-schema: Abbreviations – Python Markdown(1)

Browser

No response

Before submitting

@squidfunk
Copy link
Owner

Thanks for reporting. This is not a bug. We can't possibly oversee all extensions in the ecosystem, but you are very much encouraged to submit a PR that adds support for them. Other than that, we're not planning to do so.

@AdrianoKF
Copy link
Contributor Author

Thanks for the swift response, @squidfunk! I've submitted PR #6381, which adds support for the markdown extensions mentioned above.

AdrianoKF added a commit to AdrianoKF/neoteroi-mkdocs-plugins that referenced this issue 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.
RobertoPrevato pushed a commit to Neoteroi/mkdocs-plugins that referenced this issue 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.
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

No branches or pull requests

2 participants