-
Notifications
You must be signed in to change notification settings - Fork 9
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
Why format: md
?
#296
Comments
I think this was just a remnant of the previous code that used R Markdown and not Quarto to render documents. Since it also worked with Quarto I didn't see a reason to change. I have no idea which one of gfm or commonmark should be preferred. What kind of gfm extensions if broken because we specify |
@grantmcdermott I assume you have not committed the README.md updated by altdoc in the tinyplot package repository. |
Since CommonMark is defined as "A strongly defined, highly compatible specification of Markdown", I'd prefer using it over gfm that seems very Github centric. |
Yes, for anything other than README, it is probably more appropriate to use commonmark. |
This distinction would go away by not rendering the README as you advocate, right? |
Yes, I think the README is obviously special and needs to be handled separately (don't render, special function, special header). The simplest way is skip rendeering. |
Hi, not sure that I follow the discussion entirely (sorry; I read quickly). But, yes, what I do is render the README.md file manually with: quarto render README.qmd --to gfm This part of the workflow is actually the only real pain point that I have encountered with |
@grantmcdermott Thanks for the detailed reply! I think it would be better to turn off the automatic rendering of the README to simplify things. |
The format
md
is not mentioned in the Quarto reference, so I think it should not be used by default.altdoc/R/qmd2md.R
Lines 31 to 36 in 011cea5
I also think that the specification by preamble is ignored because it is specified in the options of the render command.
Why not
gfm
orcommonmark
?https://quarto.org/docs/reference/formats/markdown/commonmark.html
I noticed that the
gfm
extensions are not available due to themd
being specified here (manifested due to #295).Currently altdoc forces updates to README.md, so README.md rendered as
gfm
overwrites the one rendered asmd
, breaking the display.(This was accidentally circumvented on the Quarto website, but should have happened before with other formats.)
I think it is likely that many static site generators are compatible with
gfm
, but I am not convinced.At least as far as the README is concerned, it should be rendered as
gfm
.(Ideally, altdoc should do nothing. It is the user's responsibility to update it.)
The text was updated successfully, but these errors were encountered: