-
Notifications
You must be signed in to change notification settings - Fork 5
Djm/pkgdown updates #174
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
Djm/pkgdown updates #174
Conversation
* rebuild it with `devtools::render_readme()` * easier to track changes / multiple files * Note that the rebuilt figure looks a bit different.
| output: github_document | ||
| --- | ||
|
|
||
| <!-- README.md is generated from README.Rmd. Please edit that file --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was hoping there was a way to generate the README from an rmd, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does devtools::document() or check automatically run devtools::render_readme()?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should be an action to do build it automatically, but I couldn't find it. I know I've seen it used elsewhere though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not that I know of.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a handy Makefile with some chore commands, I guess in absence of something R-built-in, we use that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yea, looks like they noped out of doing it auto
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh in a comment there, found usethis::use_readme_rmd(), but it just builds the skeleton README.rmd and writes a git pre-commit hook
Changes are in the commit messages.