如何将额外文件添加到 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 文件中参考。