You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is the goal of MyST to bring more clear specifications? How MyST is compatible with other formats? Does MyST add missing features to existing formats?
Users and tool developers may have similar questions. There is a TODO in the myst-spec README repository https://github.com/executablebooks/myst-spec/blob/main/README.md so it may be good to fill that TODO. I post this question in this more general meta repository as it is a quite generic question. I can see a risk to bring fragmentation and confusion in the future if the reasoning is not communicated.
Relation to other markup languages, frameworks
[TODO]
CommonMark
GitHub Flavored Markdown
Pandoc
Unified
Markdown-It
MyST is targeted at scientific/technical writing, and outputting to multiple formats, with hopefully a community driven/maintained specification
CommonMark (and GFM): have a clear spec ✅, but limited syntax and only HTML as output format in spec
Pandoc: has multiple output formats ✅, a larger syntax, but no formal spec
markdown-it and unified are more implementation parsers of a spec (commonmark, gfm, etc)
Is the goal of MyST to bring more clear specifications?
yes
How MyST is compatible with other formats?
where possible yes, e.g. using commonmark as a "base" spec and then trying to utilise existing "pseudo-standard" extensions to that
although I guess there is no "promise" of cross-compatibility
Does MyST add missing features to existing formats?
yes; things like captioned figures, cross-document/project referencing, etc
Thx Chris. I am putting myself in the shoes of a user who needs to choose a tool. The supported format to author and publish is one the criteria I guess that will be considered, as the interoperability of those. Write research papers in a format that can be used by as much tools should be considered, hence my question.
Activity
[-]MyST vs RMarkdown vs Quarto[/-][+]MyST vs RMarkdown vs Quarto formats[/+]chrisjsewell commentedon Oct 14, 2022
Hey Eric thanks for the feedback, I hope #843 and then things like jupyter-book/myst-enhancement-proposals#4 (reply in thread) will start to address this.
Very simply IMO:
MyST is targeted at scientific/technical writing, and outputting to multiple formats, with hopefully a community driven/maintained specification
markdown-it and unified are more implementation parsers of a spec (commonmark, gfm, etc)
yes
where possible yes, e.g. using commonmark as a "base" spec and then trying to utilise existing "pseudo-standard" extensions to that
although I guess there is no "promise" of cross-compatibility
yes; things like captioned figures, cross-document/project referencing, etc
echarles commentedon Oct 14, 2022
Thx Chris. I am putting myself in the shoes of a user who needs to choose a tool. The supported format to author and publish is one the criteria I guess that will be considered, as the interoperability of those. Write research papers in a format that can be used by as much tools should be considered, hence my question.