使用devtools构建.md小插图

Question

我正在使用knitr::rmarkdown（knitr::knitr做同样的事情）而不是VignetteEngine。然后我使用devtools::build_vignettes()构建我的包装插图。

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

我已经尝试了解如何为自定义VignetteEngine指定输出，我认为它应该是可能的（毕竟，其他软件包至少使用它来构建PDF小插图）但我不能通过devtools::build_vignettes找到一种方法。是否无法手动构建小插图（即通过knitr::knit或忽略VignetteBuilder指令的类似机制？）

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

Answer 1

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

你可以在你的软件包中包含任意文档文件（按照惯例，你将它们放在inst / doc中），但它们并不被认为是小插图，所以它们不会被自动构建，像{一样的函数{1}}会忽略它们等等。

要将Rmd文件转换为md，只需在其上运行browseVignettes()。