使用devtools构建.md小插图

Question

我正在使用knitr::rmarkdown（但knitr::knitr功能相同）作为我的VignetteEngine。然后，我使用构建包小插图devtools::build_vignettes()。

这可行，但仅在中创建HTML和R输出文件inst/doc。我想要的是Markdown输出文件，因为只有该文件可以直接在Github项目页面中显示（对于HTML文件，Github显示源，对于Rmd文件，它显示渲染的输出，但是-显然-不执行R块）。

我已经尝试找出如何为custom VignetteEngines 指定输出，并且我认为应该有可能（毕竟，其他软件包至少使用它来构建PDF vignettes），但是我找不到通过这样做的方法devtools::build_vignettes。是否没有办法手动构建小插图（即通过knitr::knit忽略VignetteBuilder指令的类似机制）？

我也无法在文档/源中找到相关信息。

Answer 1

小插图的唯一输出格式是 HTML 和 PDF（以及 LaTeX，但它会转换为 PDF，不会显示）。不支持 Markdown。

您的包中可以有任意文档文件（按照惯例，您将它们放在 inst/doc 中），但它们不被视为小插图，因此它们不会自动构建，类似的函数browseVignettes()将忽略它们等。

要将 Rmd 文件转换为 md，只需运行knitr::knit它即可。