Use Font Awesome 5 for GitHub/GitLab icons. Close #231.

rstudio/rmarkdown#1991
rstudio/rmarkdown#1994

NEWS.md

@@ -49,6 +49,10 @@ break the cross-references and require an update. See this
 * Added more documention to `wflow_build()` to explain when it does and doesn't
 load code defined in a `.Rprofile` file (idea from @pcarbo).
 
+* Bug fix: `wflow_use_github()` and `wflow_use_gitlab()` now use Font Awesome 5
+syntax to insert icons into the navigation bar when a recent version of
+rmarkdown is installed (>= 2.6) (bug report from @christianholland, #231)
+
 # workflowr 1.6.2
 
 This patch release of workflowr includes minor improvements, updated

R/utility.R

@@ -456,3 +456,17 @@ create_newlines <- function(m) {
   m <- paste(m, collapse = "\n\n")
   return(m)
 }
+
+# Get Font Awesome icon for a brand
+#
+# Decide between Font Awesome 4 and 5
+# https://github.com/rstudio/rmarkdown/issues/1991
+get_fa_brand_icon <- function(brand) {
+  if (utils::packageVersion("rmarkdown") < "2.6") {
+    # Font Awesome 4: rmarkdown adds preceding "fa"
+    return(sprintf("fa-%s", brand))
+  }
+
+  # Font Awesome 5
+  return(sprintf("fab fa-%s", brand))
+}

R/wflow_use_github.R

@@ -279,7 +279,7 @@ wflow_use_github <- function(username = NULL,
 
   host <- get_host_from_remote(path = project)
   if (navbar_link && !is.na(host)) {
-    site_yml$navbar$right <- list(list(icon = "fa-github",
+    site_yml$navbar$right <- list(list(icon = get_fa_brand_icon("github"),
                                        text = "Source code",
                                        href = host))
     yaml::write_yaml(site_yml, file = site_yml_fname)

R/wflow_use_gitlab.R

@@ -221,7 +221,7 @@ wflow_use_gitlab <- function(username = NULL, repository = NULL,
 
   host <- get_host_from_remote(path = project)
   if (navbar_link && !is.na(host)) {
-    site_yml$navbar$right <- list(list(icon = "fa-gitlab",
+    site_yml$navbar$right <- list(list(icon = get_fa_brand_icon("gitlab"),
                                        text = "Source code",
                                        href = host))
     yaml::write_yaml(site_yml, file = site_yml_fname)

tests/testthat/test-vig-gitlab.R

@@ -38,7 +38,8 @@ test_that("Setup GitLab infrastructure", {
   expect_equal(length(git_status$untracked), 0)
   site_yml_fname <- file.path(s$analysis, "_site.yml")
   site_yml <- yaml::yaml.load_file(site_yml_fname)
-  expect_identical(site_yml$navbar$right[[1]][["icon"]], "fa-gitlab")
+  expect_identical(site_yml$navbar$right[[1]][["icon"]],
+                   workflowr:::get_fa_brand_icon("gitlab"))
   expect_identical(site_yml$output_dir, "../public")
 })
 

tests/testthat/test-wflow_use_github.R

@@ -27,7 +27,8 @@ test_that("wflow_use_github automates local GitHub configuration", {
   output_dir <- site_yml$output_dir
   expect_identical("../docs", output_dir)
   # Adds a link to the GitHub repository in the navigation bar
-  expect_identical(site_yml$navbar$right[[1]]$icon, "fa-github")
+  expect_identical(site_yml$navbar$right[[1]]$icon,
+                   workflowr:::get_fa_brand_icon("github"))
   expect_identical(site_yml$navbar$right[[1]]$href,
                    sprintf("https://github.com/%s/%s", username, repository))
   # Configures the Git remote settings to use GitHub
@@ -73,7 +74,8 @@ test_that("wflow_use_github can be used post GitLab", {
   output_dir <- site_yml$output_dir
   expect_identical("../docs", output_dir)
   # Adds a link to the GitHub repository in the navigation bar
-  expect_identical(site_yml$navbar$right[[1]]$icon, "fa-github")
+  expect_identical(site_yml$navbar$right[[1]]$icon,
+                   workflowr:::get_fa_brand_icon("github"))
   expect_identical(site_yml$navbar$right[[1]]$href,
                    sprintf("https://github.com/%s/%s", username, repository))
   # Configures the Git remote settings to use GitHub
@@ -221,7 +223,8 @@ test_that("wflow_use_github works when site has been published", {
   output_dir <- site_yml$output_dir
   expect_identical("../docs", output_dir)
   # Adds a link to the GitHub repository in the navigation bar
-  expect_identical(site_yml$navbar$right[[1]]$icon, "fa-github")
+  expect_identical(site_yml$navbar$right[[1]]$icon,
+                   workflowr:::get_fa_brand_icon("github"))
   expect_identical(site_yml$navbar$right[[1]]$href,
                    sprintf("https://github.com/%s/%s", username, repository))
   # Configures the Git remote settings to use GitHub

tests/testthat/test-wflow_use_gitlab.R

@@ -26,7 +26,8 @@ test_that("wflow_use_gitlab automates local GitLab configuration", {
   output_dir <- site_yml$output_dir
   expect_identical("../public", output_dir)
   # Adds a link to the GitLab repository in the navigation bar
-  expect_identical(site_yml$navbar$right[[1]]$icon, "fa-gitlab")
+  expect_identical(site_yml$navbar$right[[1]]$icon,
+                   workflowr:::get_fa_brand_icon("gitlab"))
   expect_identical(site_yml$navbar$right[[1]]$href,
                    sprintf("https://gitlab.com/%s/%s", username, repository))
   # Creates the required file .gitlab-ci.yml
@@ -154,7 +155,8 @@ test_that("wflow_use_gitlab works when site has been published", {
   output_dir <- site_yml$output_dir
   expect_identical("../public", output_dir)
   # Adds a link to the GitLab repository in the navigation bar
-  expect_identical(site_yml$navbar$right[[1]]$icon, "fa-gitlab")
+  expect_identical(site_yml$navbar$right[[1]]$icon,
+                   workflowr:::get_fa_brand_icon("gitlab"))
   expect_identical(site_yml$navbar$right[[1]]$href,
                    sprintf("https://gitlab.com/%s/%s", username, repository))
   # Creates the required file .gitlab-ci.yml