【问题标题】:`README` badges not getting rendered properly in `pkgdown` website`pkgdown` 网站中的`README` 徽章未正确呈现
【发布时间】:2020-05-11 19:33:49
【问题描述】:

到目前为止,我已经为我的 R 包创建了 6 个不同的 pkgdown 网站(例如,ggstatsplotkittyR 等),但它们都没有出现以下问题。

第一次,运行以下命令

pkgdown::build_site(
  lazy = FALSE,
  run_dont_run = TRUE,
  seed = 123,
  devel = TRUE
)

没有呈现README 徽章,我不知道为什么,因为我使用的yaml 与我的其他包相似。我在pkgdown GitHub 存储库上提出了issue,但没有帮助。

更明确地说,这是我的README 的样子-

这是pkgdown 输出的样子-

在构建网站时,我没有收到任何警告或错误。但是从这里可以看出,主页上根本没有呈现徽章。关于为什么会发生这种情况或如何解决它的任何想法?

提前致谢。

【问题讨论】:

  • 使用最新开发版本pkgdown 的 README 文件在不同的包上复制了此行为。我注意到在第一个标题之前在反引号中添加一些东西(任何东西)会使徽章重新出现。不知道为什么,但可以帮助 pkgdown 开发人员理解并成为您的解决方法。尝试在 README.Rmd 文件的第 16 行的反引号中添加单词“test”。
  • 感谢您的敏锐观察!该解决方法确实解决了问题:) 你能发布答案吗,我会接受的。

标签: r pkgdown


【解决方案1】:

我能够使用您链接的自述文件复制问题。我注意到在第一个标题之前在反引号中添加文本(任何字符)会使徽章重新出现。原因与pkgdown 如何解析自述文件以查找徽章有关。作为一种解决方法,您可以尝试在 README.Rmd 文件的第 16 行的反引号中添加单词“test”。

这似乎已在 pkgdown 的开发版中得到解决。有关更多详细信息,请参阅issue 的讨论,并考虑在徽章部分周围使用<!-- badges: start --><!-- badges: end -->

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2021-12-04
    • 2012-02-12
    • 1970-01-01
    • 1970-01-01
    • 2020-03-13
    • 2021-12-21
    • 1970-01-01
    相关资源
    最近更新 更多