问题标签 [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 投票
0 回答
7 浏览

pkgdown - 小插图可以全宽显示吗?

我正在为 R 包使用 pkgdown(当前是 opengraph 模板,但可以接受建议)。它有一个备忘单,作为小插图包含在内。必须在浏览器中全屏查看备忘单才能阅读。这在使用 R 中的 vignette() 访问它时效果很好。但在 pkgdown 站点中,格式被锁定为模板指定的较窄格式。

有没有办法禁用这个小插图的模板,只显示我在 vignette() 中看到的 html?

谢谢!

0 投票
2 回答
39 浏览

r - 函数文档中的绘图无法正确显示

我正在编写一个 R 包及其文档,roxygen2用于记录我的函数并pkgdown创建一个 github 页面。

该软件包是关于栅格的,因此我在函数文档的示例中包含了一些栅格图。

当示例在控制台中运行时,一切看起来都很好。当它们通过pkgdown包运行时(使用build_reference()build_site()),github 上的绘图显示会发生变化。

这是正确的情节

正确的情节

这就是在参考部分的 github 页面上呈现该图的方式。

错误的情节

请注意,如果相同的图包含在小插图中而不是文档中,则它们会很好地呈现。

我有点迷失在这里。您对为什么会发生这种情况以及如何纠正这种行为有什么建议吗?

0 投票
1 回答
93 浏览

javascript - r pkgdown docsearch algolia

我无法理解如何在我的 github 页面中实现 docsearch 片段(我使用的是bootstrap 3)。

包文档

  1. 发布 pkgdown 网站后,将 pkgdown 网站 URL 提交到 Docsearch。完毕

  2. 将 apiKey 和 indexName 参数的值放入您的站点 _pkgdown.yml。完毕


由于我缺乏知识,我现在很难理解这一点。

Docsearch\Algolia 给我发了电子邮件:

CSS

head将此代码段复制到 HTML标记的末尾

JavaScript

body将此代码段复制到 HTML标记的末尾

问题: 我应该在 pkgdown 生成的每个 html 页面上复制这些片段,还是有一种自动的方法可以这样做?

0 投票
1 回答
23 浏览

r - 如何控制 pkgdown 站点中包徽标的大小

我在我的包中添加了一个pkgdown站点,vcdExtra但无法弄清楚如何控制 pkgdown 构建的主页上出现的包十六进制徽标的大小,https: //friendly.github.io/vcdExtra/index.html

README.md文件包含一行以 200 像素插入图像

出现在 GitHub 上,如下所示

在此处输入图像描述

然而,由pkgdownindex.html构建的页面看起来是这样的,忽略了该height =属性。我怎样才能解决这个问题?我查看了其他pkgdown网站的来源,并没有发现任何实质性的不同。

在此处输入图像描述

0 投票
1 回答
23 浏览

r - r 包的 Gitlab CI 失败

我正在 GitLab 上构建一个 R 包,我试图让 GitLab CI 工作,问题是

  • devtools::check如果出现错误、警告或注释,则失败。我只希望它因错误而失败
  • 部署pkgdown到 GitLab 页面,它似乎不起作用?

下面是.gitlab-ci-yml我正在使用的。我使用了 R Studio 的 R 包模板来测试它。

笔记

  • 一切都在本地工作,devtools::check()产生警告和注释,但没有错误。pkgdown构建良好。测试通过。
  • Gitlab CI 正在工作,构建步骤和测试阶段通过正常,然后失败并devtools::check() 显示错误消息
  • 我通过删除短语尝试了 gitlab 页面check(),管道完成得很好,但在setting > Pages我看不到任何东西?