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

Configuration to declare additional cell-metadata keys to be considered as valid. #1217

Open
nthiery opened this issue May 19, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@nthiery
Copy link

nthiery commented May 19, 2024

In my course notebooks, I am using extensively tools such as nbgrader or rise/jupyterlab-deck which use custom cell-metadata (respectively nbgrader={...}, slideshow={...}). The myst CLI is (rightfully) not aware of these metadata; and complains:

⚠️  Devoirs/PremiersCalculs/01-valeurs-types.md:921 unexpected option "nbgrader" provided for directive: code-cell

This is producing hundreds of warnings which means the important warnings are not well visible.

Proposal

Add configuration to either silence completely myst CLI's complaints about unknown cell metadata, or better to register additional cell metadata keys that should be considered as valid. Something like:

project:
  ...
  additional-cell-metadata-keys: ['nbgrader', 'slideshow']

Thanks :-)

@nthiery nthiery added the enhancement New feature or request label May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant