如何添加额外的文件到pkgdown站点？

Question

我有一个包，其中包含一些Javascript代码以及R代码。我可以使用pkgdown为包中的R文档构建一个由Github托管的网站，方法是正确设置并运行

pkgdown::deploy_to_branch()

我还可以使用JSDoc构建一个本地网站来记录Javascript代码，并将其放在pkgdown使用的docs目录中，其中包含来自其他部分的链接。这在本地工作，但当我使用上面的命令将其部署到Github时，JSDoc文件并不包括在内。

我如何告诉pkgdown在它部署到Github的网站中包含JSDoc文件？

这个问题实际上与JSDoc无关；我可以认为它有一个子目录，其中包含我希望与pkgdown生成的所有文件一起部署的文件。

Answer 1

我找到了答案:我需要将JSDoc生成的文件视为要复制到网站中的“资产”。

详细说明：

我可以在我喜欢的任何地方生成这些文件。我选择将它们放在它们所在目录下名为.JSDoc/javascript的子目录中。

然后，我需要编辑包的主目录中的_pkgdown.yml文件，并添加一个包含以下内容的部分

template:
  assets: path/to/.JSDoc

其中path/to是相对于主目录的。注意，我没有包括子目录名称的第二部分(javascript)。

然后，当pkgdown::build_site()或pkgdown::deploy_to_branch()运行时，它会将.JSDoc目录中的所有内容复制到它正在生成的网站的顶层。因为我在那里只有javascript目录，所以我在最终网站中得到了一个名为javascript的顶级目录。我可以从其他pkgdown文件中引用它。