search

jupyter-book / myst-spec

MyST is designed to create publication-quality, computational documents written entirely in Markdown.
https://mystmd.org/spec
MIT License
14 stars 6 forks source link

Register MYST as an official markdown variant with IANA #58

Open stevejpurves opened 1 year ago

stevejpurves commented 1 year ago

IANA accepted an official registration for the text/markdown mimetype here: https://www.iana.org/assignments/media-types/text/markdown

Section 6.1 of the RFC specified a IANA based registry for markdown variants that is established here: https://www.iana.org/assignments/markdown-variants/markdown-variants.xhtml

The list of variants registered is woefully lacking but the registration mechanism allow formalize which mimetype variant parameter should be used to identify a flavor of markdown.

i.e. text/markdown;variant=MYST or text/markdown;variant=GFM

Even having an open draft RFC (probably for years) might allow us to establish and register the MYST parameter at least somewhat formally.

It is also worth noting that pandoc additionally provides for more parameters, that can specify which extensions/directives are loaded.

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

rowanc1 commented 1 year ago

Thanks @stevejpurves for brining this up! I worked with @choldgraf and @mmcky to get this done, and we have finished the registration process.

This is now super official!! 🎉🎉🎉🎉

text/markdown;variant=myst

We went with lowercase, similar to pandoc and quarto.

I will leave this up to document in the spec docs.