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

GH Action to render README.qmd ? #17

Open
egouldo opened this issue Oct 11, 2022 · 2 comments
Open

GH Action to render README.qmd ? #17

egouldo opened this issue Oct 11, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@egouldo
Copy link
Member

egouldo commented Oct 11, 2022

No version of devtools::build_readme() for .qmd files https://devtools.r-lib.org/reference/build_rmd.html ... so, should we set up a GH action to instead render the README automatically? I've been forgetting to render this manually after I make changes to the README.

See https://github.com/quarto-dev/quarto-actions/tree/main/render for a GH actions for quarto_render(), usage here (🗒️ I've substituted to: html with to: md, which is what we want, untested, however):

- name: Render Quarto Project
  uses: quarto-dev/quarto-actions/render@v2
  with:
    to: md # If set, it will be equivalent to `quarto render --to md`
    path: source-folder # By default, the current working dir is used i.e `quarto render .`
@egouldo egouldo added enhancement New feature or request help wanted Extra attention is needed labels Oct 11, 2022
@psychtek
Copy link
Collaborator

Ill check this out and test - should be straight forward.

@Doi90
Copy link
Contributor

Doi90 commented Mar 28, 2023

Is there a reason we're using .qmd instead of .rmd?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants