r - 如何将额外文件添加到 pkgdown 站点？

Question

我有一个包含一些 Javascript 代码和 R 代码的包。我可以pkgdown通过正确设置和运行来为包中的 R 文档构建一个由 Github 托管的网站

pkgdown::deploy_to_branch()

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

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

这个问题真的无关JSDoc; 我可以将其视为具有我想要部署的文件的子目录以及生成的所有文件pkgdown。

标签： rpkgdown

Answer 1

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

详细地：

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

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

template:
  assets: path/to/.JSDoc

wherepath/to是相对于主目录的。请注意，我不包括javascript子目录名称的第二部分 ( )。

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