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

[Feature]: build r markdown automatically #39

Open
k-doering-NOAA opened this issue Jun 17, 2022 · 1 comment
Open

[Feature]: build r markdown automatically #39

k-doering-NOAA opened this issue Jun 17, 2022 · 1 comment
Assignees

Comments

@k-doering-NOAA
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Many people use r markdown documents to document processes. In some cases, it may be helpful to have the ability torender these automatically through github actions rather than having to remember to manually render it locally. While this was not included in the poll on accident, the interest in bookdown suggests that there may also be interest in r markdown rendering.

Describe the solution you would like.

  • A new reusable action workflow that updates r markdown and pushes the rendered document where the user desires.
  • A new {usethis} style function that will automatically create the necessary files in your repo for you.

Describe alternatives you have considered

With Quarto as an up and coming replacement for r markdown, there may be less people using r markdown. However, I think there are still a large number of r markdown documents out there that people may want to use, and I suspect it is still only early adopters using Quarto so far. I think developing workflows for both r markdown and quarto make sense.

Additional context

No response

@k-doering-NOAA k-doering-NOAA added enhancement New feature or request triage_needed This issue needs review labels Jun 17, 2022
@k-doering-NOAA k-doering-NOAA self-assigned this Jun 17, 2022
@k-doering-NOAA
Copy link
Collaborator Author

k-doering-NOAA commented Jun 28, 2022

Note that an example of rendering a markdown file (in this case a readme) is available at https://github.com/nmfs-fish-tools/SSMSE/blob/main/.github/workflows/render-readme.yml (and also in nmfspalette)

@k-doering-NOAA k-doering-NOAA added new_feature and removed enhancement New feature or request triage_needed This issue needs review labels Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant