问题标签 [pkgdown]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
3 回答
433 浏览

r - 在 pkgdown 参考 yaml 中包含“所有其他功能”

我有一个pkgdown网站,我在其中将许多功能分组到参考.yml文件中的类别中。我想知道是否有一种方法可以将我没有明确归类的所有功能放入它们自己的类别中。我唯一的想法就是matches像这样使用该功能:

但这myFunction同时包含“someCategory”和“other”类别。我想做的是匹配所有不在一个类别中的函数。

谢谢!

0 投票
2 回答
235 浏览

r - pkgdown 小插图代码块间距

pkgdown::build_site()使用所有默认选项运行时,我遇到了代码块输出问题。块在html 内容中呈现,每行代码之间都有多余的空白。例如:

出来为:

或者,以屏幕截图的形式:

我在 html 生成的内容中没有遇到过这个问题blogdown,尽管我知道这是一个独立的包,并且README.md文件渲染也很好。

我在 pkgdown 代码块中找不到任何关于间距的内容,我想知道从哪里开始解决这个问题。

小插图的 YAML 部分使用默认条目:

设置块也是标准的。


会议详情:

0 投票
2 回答
271 浏览

r - pkgdown 中的自定义模板

在这里pkgdown文档说我可以使用templates_pathin 中的键提供我自己的模板(页脚等) _pkgdown.yml。我正在努力让pkgdown从https://github.com/wlandau-lilly/drake/commit/2ca610f932be8d504560027b70106b5d57e3f0ea注意到我的自定义页脚,但我找不到任何指导示例。

0 投票
1 回答
80 浏览

r - pkgdown htmlwidget - 示例

我已经为许多 htmlwidgets 尝试了 pkgdown,但没有示例工作。他们都返回相同的错误

  • 还原yaml软件包版本没有帮助。
  • 升级到 pandoc2.1.3也没有帮助。
0 投票
0 回答
99 浏览

r - 'pkgdown' 用于多个包

我们小组将 R 包(供内部使用)发布到类似 CRAN 的存储库。用户(正确地)抱怨说,如果不启动 R 并以?function_name交互方式进行操作,他们就不能很容易地访问文档。

所以我想建立一个网站,其中包含我小组创建的所有版本的 R 包的文档。

如果我pkgdown::build_site()在包的顶级目录中执行此操作,则会创建一个很好的自包含树docs/,其中包含 HTML 文件以及该包的所有文档。它甚至在每一页的顶部都有一个突出的版本号,这很好。

现在我想将该文档树放在一个更大的站点中,以便用户可以浏览到他们正在寻找的包,查看以前的版本等。有人为此设置了解决方案吗?

我认为该docs/目录可以简单地rsync连接到网络服务器,从 info in 构建路径DESCRIPTION,例如:

但这重复做有点尴尬——在pkgdown或其他类似的包中是否有对这个用例的支持(不一定与 相关pkgdown,会使用最合适的包)?

0 投票
1 回答
159 浏览

r - 与 YAML 序列化程序相关的 pkgdown build_site() 出错

当我运行时pkgdown::build_site(),我收到以下错误:

顺着函数链,我发现问题似乎是在调用时触发的yaml::as.yaml(meta)。这是一种无需整个软件包即可重现错误的快速方法(请注意,这meta是由 pkgdown 以这种形式创建的):

这是我的会话信息,以防万一:

0 投票
0 回答
104 浏览

r - 环境变量导致 pkgdown::build_suite() 中的循环

这是上一篇文章(在 R 包中包含 Shiny 应用程序:传输输入参数)的延续,该文章成功解决了我的问题,但又导致了另一个问题。

基本上,我正在运行一个 Shiny 应用程序作为 R 包的一部分。为此,我有一个环境变量 PKGENVIR。从上一篇文章中可以看出,我使用以下方法完成了此操作:

在 server.R 中:

但是,我也在尝试将其转变为 pkgdown 站点。结果,我运行:

但是,这似乎创建了一个无限循环,因为该过程在步骤冻结:

关于如何解决这个问题的任何想法都会非常有帮助。在此之前我一直在运行 pkgdown::build_site() 并且没有遇到问题。因此,我几乎可以肯定这是由于这个新的环境变量。

0 投票
0 回答
48 浏览

r - 在所有页面上生成“编辑此文档”链接

visNetwork我真的很喜欢用户手册中的“Fork me on GitHub”横幅。

在此处输入图像描述

对于pkgdownbookdownblogdown网站,有没有一种方便的方法可以在所有页面的标题中生成这样的链接?

0 投票
1 回答
80 浏览

devtools - 如何运行 pkgdown 使 YAML 生效?

有人可以帮助我了解如何更改网址,例如 pkgdown 网站上的作者吗?

https://pkgdown.r-lib.org/reference/build_site.html

假设我把这个 yml 作为 inst/_pkgdown.yml

添加这些行

最后我输入了设置选项

还放置在README.Rmd

我应该如何运行pkgdown::build_site()pkgdown::build_home()生效?我需要指定一个列表override吗?如果没有,我可以在override=参数中添加此信息吗?如何?这在手册中对我来说完全不清楚。

出于某种原因,我最终得到了一个pkgdown.yml缺少这些信息位的信息,最终生成的网站上的链接是错误的。

0 投票
1 回答
125 浏览

html - 在 pkgdown index.html 中添加版权所有者或资助者的徽标

我想在我正在维护的 R 包的静态网页中添加版权所有者/资助者的徽标。该网页是使用 pkgdown 创建的。

我看到,在他们的静态网页上,所有 tidyverse 软件包的开发人员列表末尾都有 RStudio 徽标,例如https://dplyr.tidyverse.org/。我浏览了几个 yaml 配置文件并浏览了 pkgdown 的源代码,但似乎无法追踪它的指定位置,尽管我可以在 pkgdown 生成的 html 文件中找到它;我可以说它是从这个网址https://www.tidyverse.org/rstudio-logo.svg获取的;

然后,我尝试将“Rstudio”放在我的包的作者中,我看到了徽标!所以这在我想的 pkgdown 中以某种方式硬编码,即当描述中的一位作者是“RStudio”时,徽标是从上面的 url 中提取的。

如何使用我自己的徽标实现类似的效果,无论是在本地还是在 url 中?