Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

MyST vs RMarkdown vs Quarto formats #847

Closed
echarles opened this issue Oct 14, 2022 · 2 comments
Closed

MyST vs RMarkdown vs Quarto formats #847

echarles opened this issue Oct 14, 2022 · 2 comments
Labels
meeting A team meeting

Comments

@echarles
Copy link

I am trying to understand the reasoning behind MyST specification (https://github.com/executablebooks/myst-spec), espcially looking at similar initiatives like RMarkdown as the format used by Quarto.

I have not found a clear specification of RMarkdown format (apart from this bookdown page https://bookdown.org/yihui/rmarkdown/markdown-document.html and this RStudio page https://rmarkdown.rstudio.com/authoring_quick_tour.html). The Quarto spec is also sparse (https://quarto.org/docs/authoring/markdown-basics.html). As a user, I have been using bookdown to create PDF with citations...

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
@echarles echarles added the meeting A team meeting label Oct 14, 2022
@echarles echarles changed the title MyST vs RMarkdown vs Quarto MyST vs RMarkdown vs Quarto formats Oct 14, 2022
@chrisjsewell
Copy link
Member

chrisjsewell commented 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

  • 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

@echarles
Copy link
Author

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.

@executablebooks executablebooks locked and limited conversation to collaborators Feb 15, 2023
@choldgraf choldgraf converted this issue into discussion #945 Feb 15, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
meeting A team meeting
Projects
None yet
Development

No branches or pull requests

2 participants