Finding badges (#996)

Closes #670

NEWS.md

@@ -1,5 +1,7 @@
 # pkgdown 1.3.0.9000 (development version)
 
+* Badges can be extracted from the README paragraph coming after the comment `<!-- badges: start -->`, to build the "dev status" section of the sidebar (#670, @gaborcsardi, @maelle)
+
 * One can override the title of the homepage via a `title` field in the config (#957, @maelle).
 
 * Links to external documentation now point to [rdrr.io](https://rdrr.io) (#998).

R/build-home.R

@@ -89,8 +89,14 @@
 #'
 #' @section Badges:
 #' Status badges are displayed in the sidebar under the section "Dev status".
-#' This section is automatically populated if the first paragraph of the
-#' homepage consists solely of status badges as linked images.
+#' This section is automatically populated if there is an identifiable badges
+#'  paragraph in the homepage source (index.Rmd, index.md, README.Rmd,
+#'  README.md):
+#'  * pkgdown first looks for a paragraph starting with `<!-- badges: start -->`
+#' and ending with `<!-- badges: end -->` as created by
+#' `usethis::use_readme_md()` or `usethis::use_readme_rmd()`;
+#'  * failing that, pkgdown looks at the first paragraph, and uses it if it
+#'   only contains images.
 #'
 #' @inheritParams build_articles
 #' @export

R/html-tweak.R

@@ -242,8 +242,15 @@ tweak_homepage_html <- function(html, strip_header = FALSE) {
 
 # Mutates `html`, removing the badge container
 badges_extract <- function(html) {
-  # First try specially named div; then try first paragraph
+  # First try specially named div;
   x <- xml2::xml_find_first(html, "//div[@id='badges']")
+
+  # then try usethis-readme-like paragraph;
+  if (length(x) == 0) {
+    x <- xml2::xml_find_all(html, ".//*/comment()[contains(., 'badges: start')]/following-sibling::p[1]")
+  }
+
+  # finally try first paragraph
   if (length(x) == 0) {
     x <- xml2::xml_find_first(html, "//p")
   }
@@ -276,7 +283,6 @@ badges_extract_text <- function(x) {
   xml <- xml2::read_html(x)
   badges_extract(xml)
 }
-
 # Update file on disk -----------------------------------------------------
 
 update_html <- function(path, tweak, ...) {

tests/testthat/test-html-tweak.R

@@ -162,9 +162,27 @@ test_that("badges can't contain an extra text", {
   )
 })
 
+
 test_that("badges can be in special div", {
   expect_equal(
     badges_extract_text('<p></p><div id="badges"><a href="x"><img src="y"></a></div>'),
     '<a href="x"><img src="y"></a>'
   )
 })
+
+test_that("badges-paragraph a la usethis can be found", {
+  string <- '
+  <blockquote>
+  <p>Connect to thisisatest, from R</p>
+  </blockquote>
+  <!-- badges: start -->
+  <p><a href="https://travis-ci.org/thisisatest/thisisatest"><img src="https://travis-ci.org/thisisatest/thisisatest.svg?branch=master" alt="Linux Build Status"></a> <!-- badges: end --></p>
+  <div id="introduction" class="section level2">
+  <h2 class="hasAnchor">
+  <a href="#introduction" class="anchor"></a>Introduction</h2>
+  <p>The thingie is a blabla.</p>
+  <p>The <code>thisisatest</code> package also blabla.</p>'
+
+  badges_page <- xml2::read_html(string)
+  expect_equal(length(badges_extract(badges_page)), 1)
+})

vignettes/pkgdown.Rmd

@@ -82,8 +82,9 @@ In addition to home page content from the README (e.g., installation instruction
     Convert your package logo to a favicon with `build_favicon()`
 
 
-*   Badges in the home page source file (e.g. `README.Rmd`) are linked in the 
-    sidebar under "Dev status".
+*   Badges in the home page source file (index.Rmd, index.md, README.Rmd, README.md) are automatically displayed in the sidebar under the section "Dev status" if there is an identifiable badges paragraph:
+    * pkgdown first looks for a paragraph starting with `<!-- badges: start -->` and ending with `<!-- badges: end -->` as created by `usethis::use_readme_md()` or `usethis::use_readme_rmd()`;
+    * failing that, pkgdown looks at the first paragraph, and uses it if it only contains images.
 
 *   A link for bug reports is added if the `BugReports` field in 
     `DESCRIPTION` contains a link. You can use `usethis::use_github_links()`