chore: update pkgdown, documentation (#122)

ijlyttle · web-flow · commit cd8c2540cd5d · 2025-04-05T14:04:37.000-05:00
* update URL, Roxygen version

* rationalize badges

* add alt text

* update articles
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -20,6 +20,7 @@ Description: The Bootstrap framework lets you add some JavaScript functionality
   popovers, and an accordion sidebar framework (not described at Bootstrap site).
   Please note this package was designed for Bootstrap 3.3.
 License: MIT + file LICENSE
+URL: https://ijlyttle.github.io/bsplus/
 Depends: R (>= 3.3.0)
 Imports:
     htmltools,
@@ -31,10 +32,9 @@ Imports:
     glue,
     jsonlite,
     methods
-URL: https://github.com/ijlyttle/bsplus
 BugReports: https://github.com/ijlyttle/bsplus/issues
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.3.2
 Encoding: UTF-8
 Suggests: 
     testthat,
diff --git a/README.md b/README.md
@@ -2,8 +2,6 @@
 
 <!-- badges: start -->
 [![CRAN status](https://www.r-pkg.org/badges/version/bsplus)](https://cran.r-project.org/package=bsplus)
-[![R build status](https://github.com/ijlyttle/bsplus/workflows/R-CMD-check/badge.svg)](https://github.com/ijlyttle/bsplus/actions)
-[![Coverage Status](https://img.shields.io/codecov/c/github/ijlyttle/bsplus/main.svg)](https://codecov.io/github/ijlyttle/bsplus?branch=main)
 [![R-CMD-check](https://github.com/ijlyttle/bsplus/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ijlyttle/bsplus/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
diff --git a/man/bs_modal.Rd b/man/bs_modal.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -1,32 +1,23 @@
+url: https://ijlyttle.github.io/bsplus/
+
+development:
+  mode: auto
+
 template:
   params:
     bootswatch: sandstone
   assets: "inst/pkgdown/assets"
 
-development:
-  mode: auto
-
 navbar:
+  structure:
+    left: [setup, reference, articles, news]
+    right: [search, github]
   components:
-    articles:
-      text: Articles
-      menu:
-      - text: "Function Families"
-      - text: "---"
-      - text: "collpase"
-        href: articles/collapse.html
-      - text: "accordion"
-        href: articles/accordion.html
-      - text: "accordion_sidebar"
-        href: articles/accordion_sidebar.html
-      - text: "tooltip_popover"
-        href: articles/tooltip_popover.html
-      - text: "modal"
-        href: articles/modal.html
-      - text: "carousel"
-        href: articles/carousel.html
-      - text: "shiny_help_links"
-        href: articles/shiny_help_links.html
+    setup:
+      text: Get Started
+      href: articles/bsplus.html
+
+
 
 reference:
   - title: "Components"
diff --git a/vignettes/accordion.Rmd b/vignettes/accordion.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Accordion"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
diff --git a/vignettes/accordion_sidebar.Rmd b/vignettes/accordion_sidebar.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Accordion Sidebar"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
diff --git a/vignettes/bsplus.Rmd b/vignettes/bsplus.Rmd
@@ -205,19 +205,19 @@ An carousel can be useful to cycle through slides with related content. There li
 ```{r}
 bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
   bs_append(
-    content = bs_carousel_image(src = image_uri("img/john.jpg")),
+    content = bs_carousel_image(src = image_uri("img/john.jpg"), alt = "John Lennon"),
     caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = image_uri("img/paul.jpg")),
+    content = bs_carousel_image(src = image_uri("img/paul.jpg"), alt = "Paul McCartney"),
     caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = image_uri("img/george.jpg")),
+    content = bs_carousel_image(src = image_uri("img/george.jpg"), alt = "George Harrison"),
     caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = image_uri("img/ringo.jpg")),
+    content = bs_carousel_image(src = image_uri("img/ringo.jpg"), alt = "Ringo Starr"),
     caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
   ) 
 ```
@@ -260,7 +260,7 @@ shiny::runApp(system.file("shiny", "tooltip_popover_modal", package = "bsplus"))
 
 Here's what it looks like:
 
-![](img/popover.png)
+![](img/popover.png){alt="Demonstration of popover with information icon"}
 
 To see more of the help-link framework, including more examples and a proposed convention for icons, please read [this article](https://ijlyttle.github.io/bsplus/articles/shiny_help_links.html).
 
diff --git a/vignettes/carousel.Rmd b/vignettes/carousel.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Carousel"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
@@ -20,19 +17,19 @@ The `content` and `caption` arguments can be composed using the helper functions
 ```{r}
 bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
   bs_append(
-    content = bs_carousel_image(src = "img/john.jpg"),
+    content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon"),
     caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = "img/paul.jpg"),
+    content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney"),
     caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = "img/george.jpg"),
+    content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison"),
     caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
   ) %>%
   bs_append(
-    content = bs_carousel_image(src = "img/ringo.jpg"),
+    content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr"),
     caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
   ) 
 ```
@@ -46,10 +43,10 @@ Here's another rendering of the carousel, this time:
 ```{r}
 bs_carousel(id = "with_the_beatles") %>%
   bs_set_data(interval = FALSE) %>%
-  bs_append(content = bs_carousel_image(src = "img/john.jpg")) %>%
-  bs_append(content = bs_carousel_image(src = "img/paul.jpg")) %>%
-  bs_append(content = bs_carousel_image(src = "img/george.jpg")) %>%
-  bs_append(content = bs_carousel_image(src = "img/ringo.jpg")) 
+  bs_append(content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon")) %>%
+  bs_append(content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney")) %>%
+  bs_append(content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison")) %>%
+  bs_append(content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr")) 
 ```
 
 ## Reference
diff --git a/vignettes/collapse.Rmd b/vignettes/collapse.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Collapse"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
diff --git a/vignettes/modal.Rmd b/vignettes/modal.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Modals"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
diff --git a/vignettes/shiny_help_links.Rmd b/vignettes/shiny_help_links.Rmd
@@ -1,8 +1,5 @@
 ---
 title: "Shiny-input help links"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
 ---
 
 ```{r}
@@ -38,7 +35,7 @@ As of writing, I don't know how to include operable **shiny** inputs in an html
 shiny::runApp(system.file("shiny", "tooltip_popover_modal", package = "bsplus"))
 ```
 
-![](img/popover.png)
+![](img/popover.png){alt="Demonstration of popover with information icon"}
 
 To promote consistency, the following convention is proposed:
 
diff --git a/vignettes/tooltip_popover.Rmd b/vignettes/tooltip_popover.Rmd
@@ -1,8 +1,5 @@
 ---
-title: "Tooltips and popovers"
-author: "Ian Lyttle"
-date: "`r Sys.Date()`"
-output: rmarkdown::html_vignette
+title: "Tooltips and Popovers"
 ---
 
 ```{r}
