README.Rmd won't allow pkgdown site to build

[adamhsparks]

If using pkgdown to build a site, the process fails with:

Updating README.md
Error in (function (variant = "markdown_strict", preserve_yaml = FALSE,  : 
  unused argument (html_preview = FALSE)

Currently the YAML reads:

---
output:
  md_document:
    variant: markdown_github
---

changing the YAML to instead be:

output: github_document

builds the _pkgdown_site

[adamhsparks]

Is this related to the "Data" formatting?

I've just removed the bold formatting from it because of the automatic link that appears, how does that even happen?

[benmarwick]

Thanks, can you show me the exact lines that you ran just before you got that error message? I'd like to try and reproduce what you describe

[adamhsparks]

I just set up a dummy project to test it.

Following the directions in rrtools README.md file up to

rrtools::use_readme_rmd()

and then running

pkgdown::build_site()

Recreated the error for me.

It's referred to here: https://github.com/hadley/pkgdown/issues/286

Hope that's clear enough to help?

[benmarwick]

Thank, yes, that's great. Looking at the issue thread you mention, it seems that the omni-readme template that I took from devtools might be out of date since pkgdown appears. I'll try updating it with this one (https://github.com/r-lib/usethis/blob/master/inst/templates/omni-README) and test your code.

[benmarwick]

Ok, I've updated the readme template and can build the pkgdown site following your code above:

Let me know how that works for you.

[adamhsparks]

Confirmed. Thanks @benmarwick