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

Is compatibility to the RMarkdown format a good idea? #1

Open
mb21 opened this issue Sep 17, 2018 · 0 comments
Open

Is compatibility to the RMarkdown format a good idea? #1

mb21 opened this issue Sep 17, 2018 · 0 comments

Comments

@mb21
Copy link
Owner

mb21 commented Sep 17, 2018

It would be nice to have a common document format for programs/editors/IDEs that call pandoc (or indeed potentially other markdown engines). The format should be extensible, but common things (like whether pandoc should be called with --toc for this specific document) should be standardized.

Jekyll already started this (AFAIK), by introducing the YAML metadata with the title keys, which other programs followed. Since Rmarkdown seems somewhat wide-spread, I thought maybe it's a good idea to picky-pack on that. Even though html_document in rmarkdown files refers to the name of the R function, not the name of the pandoc output format, although the two are of course closely related. From the panrun README:

The idea is to be somewhat compatible with rmarkdown's document format. Therefore you can use, for example, either the html or html_document key (or even pdf_document or slidy_presentation), or either toc-depth or toc_depth, and the value of pandoc_args is also passed on.

(However, as opposed to rmarkdown, panrun doesn't do anything more than passing on the options it finds.)

Question: is this useful to anyone, or does this introduce more confusion, since a lot of rmarkdown-options will be silently ignored?

@yihui, would love to hear your thoughts on this. Btw, what does rmarkdown do with keys it doesn't recognize?

@mb21 mb21 mentioned this issue Oct 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant