-
Notifications
You must be signed in to change notification settings - Fork 402
paired md:myst format also works as MyST Markdown #1315
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2cb2f80
split and merge myst-frontmatter and metadata
itcarroll c9a7312
tests updated for re-ordered metadata
itcarroll f1fdbd8
accidental inclusion
itcarroll f825cb8
myst only warns on invalid yaml
itcarroll 97e32ea
pre-commit black
itcarroll 2d7dda8
Skip tests on myst notebooks when myst is not available
mwouts 9003a62
Update CHANGELOG
mwouts File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer not to add a new configuration option - especially because this one is only implemented for the MyST format.
Do you think it would be feasible to use instead the list of frontmatter fields for moving the frontmatter fields back and forth from the MyST header to the raw cell?
When a field is in both the frontmatter fields and the
notebook_metadata_filter
like e.g. the kernelspecs, it should remain in the notebook metadata.And when a field of the frontmatter is not in the raw cell it should not go to the main header but remain in the raw cell (but then we need to extend the existing raw cell with the metadata coming from the frontmatter fields... note to myself: add a test for that case)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I take that suggestion back, the list of frontmatter fields is actually very long and will most likely change over time! Please keep what you have for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the configuration options because I suspect most users will eventually realize that only "kernelspec" should be at the root level (in addition to the raw cell frontmatter). Having the remaining notebook metadata under "jupyter" is much safer, since MyST has many fields and explicitly says "jupyter" is ignored by MyST at the file level.
I sorta began to implement it for other formats by defining a default ("-all") in
metadata_filter.py
. But well, no, that would be time poorly spent.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless you ask for it implemented everywhere, then it would not be poorly spent!