Skip to content

Commit cd8c254

Browse files
authored
chore: update pkgdown, documentation (#122)
* update URL, Roxygen version * rationalize badges * add alt text * update articles
1 parent 251d00f commit cd8c254

File tree

12 files changed

+41
-64
lines changed

12 files changed

+41
-64
lines changed

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Description: The Bootstrap framework lets you add some JavaScript functionality
2020
popovers, and an accordion sidebar framework (not described at Bootstrap site).
2121
Please note this package was designed for Bootstrap 3.3.
2222
License: MIT + file LICENSE
23+
URL: https://ijlyttle.github.io/bsplus/
2324
Depends: R (>= 3.3.0)
2425
Imports:
2526
htmltools,
@@ -31,10 +32,9 @@ Imports:
3132
glue,
3233
jsonlite,
3334
methods
34-
URL: https://github.com/ijlyttle/bsplus
3535
BugReports: https://github.com/ijlyttle/bsplus/issues
3636
Roxygen: list(markdown = TRUE)
37-
RoxygenNote: 7.2.1
37+
RoxygenNote: 7.3.2
3838
Encoding: UTF-8
3939
Suggests:
4040
testthat,

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
<!-- badges: start -->
44
[![CRAN status](https://www.r-pkg.org/badges/version/bsplus)](https://cran.r-project.org/package=bsplus)
5-
[![R build status](https://github.com/ijlyttle/bsplus/workflows/R-CMD-check/badge.svg)](https://github.com/ijlyttle/bsplus/actions)
6-
[![Coverage Status](https://img.shields.io/codecov/c/github/ijlyttle/bsplus/main.svg)](https://codecov.io/github/ijlyttle/bsplus?branch=main)
75
[![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)
86
<!-- badges: end -->
97

man/bs_modal.Rd

Lines changed: 11 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkgdown/_pkgdown.yml

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,23 @@
1+
url: https://ijlyttle.github.io/bsplus/
2+
3+
development:
4+
mode: auto
5+
16
template:
27
params:
38
bootswatch: sandstone
49
assets: "inst/pkgdown/assets"
510

6-
development:
7-
mode: auto
8-
911
navbar:
12+
structure:
13+
left: [setup, reference, articles, news]
14+
right: [search, github]
1015
components:
11-
articles:
12-
text: Articles
13-
menu:
14-
- text: "Function Families"
15-
- text: "---"
16-
- text: "collpase"
17-
href: articles/collapse.html
18-
- text: "accordion"
19-
href: articles/accordion.html
20-
- text: "accordion_sidebar"
21-
href: articles/accordion_sidebar.html
22-
- text: "tooltip_popover"
23-
href: articles/tooltip_popover.html
24-
- text: "modal"
25-
href: articles/modal.html
26-
- text: "carousel"
27-
href: articles/carousel.html
28-
- text: "shiny_help_links"
29-
href: articles/shiny_help_links.html
16+
setup:
17+
text: Get Started
18+
href: articles/bsplus.html
19+
20+
3021

3122
reference:
3223
- title: "Components"

vignettes/accordion.Rmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Accordion"
3-
author: "Ian Lyttle"
4-
date: "`r Sys.Date()`"
5-
output: rmarkdown::html_vignette
63
---
74

85
```{r}

vignettes/accordion_sidebar.Rmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Accordion Sidebar"
3-
author: "Ian Lyttle"
4-
date: "`r Sys.Date()`"
5-
output: rmarkdown::html_vignette
63
---
74

85
```{r}

vignettes/bsplus.Rmd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,19 +205,19 @@ An carousel can be useful to cycle through slides with related content. There li
205205
```{r}
206206
bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
207207
bs_append(
208-
content = bs_carousel_image(src = image_uri("img/john.jpg")),
208+
content = bs_carousel_image(src = image_uri("img/john.jpg"), alt = "John Lennon"),
209209
caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
210210
) %>%
211211
bs_append(
212-
content = bs_carousel_image(src = image_uri("img/paul.jpg")),
212+
content = bs_carousel_image(src = image_uri("img/paul.jpg"), alt = "Paul McCartney"),
213213
caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
214214
) %>%
215215
bs_append(
216-
content = bs_carousel_image(src = image_uri("img/george.jpg")),
216+
content = bs_carousel_image(src = image_uri("img/george.jpg"), alt = "George Harrison"),
217217
caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
218218
) %>%
219219
bs_append(
220-
content = bs_carousel_image(src = image_uri("img/ringo.jpg")),
220+
content = bs_carousel_image(src = image_uri("img/ringo.jpg"), alt = "Ringo Starr"),
221221
caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
222222
)
223223
```
@@ -260,7 +260,7 @@ shiny::runApp(system.file("shiny", "tooltip_popover_modal", package = "bsplus"))
260260

261261
Here's what it looks like:
262262

263-
![](img/popover.png)
263+
![](img/popover.png){alt="Demonstration of popover with information icon"}
264264

265265
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).
266266

vignettes/carousel.Rmd

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Carousel"
3-
author: "Ian Lyttle"
4-
date: "`r Sys.Date()`"
5-
output: rmarkdown::html_vignette
63
---
74

85
```{r}
@@ -20,19 +17,19 @@ The `content` and `caption` arguments can be composed using the helper functions
2017
```{r}
2118
bs_carousel(id = "the_beatles", use_indicators = TRUE) %>%
2219
bs_append(
23-
content = bs_carousel_image(src = "img/john.jpg"),
20+
content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon"),
2421
caption = bs_carousel_caption("John Lennon", "Rhythm guitar, vocals")
2522
) %>%
2623
bs_append(
27-
content = bs_carousel_image(src = "img/paul.jpg"),
24+
content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney"),
2825
caption = bs_carousel_caption("Paul McCartney", "Bass guitar, vocals")
2926
) %>%
3027
bs_append(
31-
content = bs_carousel_image(src = "img/george.jpg"),
28+
content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison"),
3229
caption = bs_carousel_caption("George Harrison", "Lead guitar, vocals")
3330
) %>%
3431
bs_append(
35-
content = bs_carousel_image(src = "img/ringo.jpg"),
32+
content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr"),
3633
caption = bs_carousel_caption("Ringo Starr", "Drums, vocals")
3734
)
3835
```
@@ -46,10 +43,10 @@ Here's another rendering of the carousel, this time:
4643
```{r}
4744
bs_carousel(id = "with_the_beatles") %>%
4845
bs_set_data(interval = FALSE) %>%
49-
bs_append(content = bs_carousel_image(src = "img/john.jpg")) %>%
50-
bs_append(content = bs_carousel_image(src = "img/paul.jpg")) %>%
51-
bs_append(content = bs_carousel_image(src = "img/george.jpg")) %>%
52-
bs_append(content = bs_carousel_image(src = "img/ringo.jpg"))
46+
bs_append(content = bs_carousel_image(src = "img/john.jpg", alt = "John Lennon")) %>%
47+
bs_append(content = bs_carousel_image(src = "img/paul.jpg", alt = "Paul McCartney")) %>%
48+
bs_append(content = bs_carousel_image(src = "img/george.jpg", alt = "George Harrison")) %>%
49+
bs_append(content = bs_carousel_image(src = "img/ringo.jpg", alt = "Ringo Starr"))
5350
```
5451

5552
## Reference

vignettes/collapse.Rmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Collapse"
3-
author: "Ian Lyttle"
4-
date: "`r Sys.Date()`"
5-
output: rmarkdown::html_vignette
63
---
74

85
```{r}

vignettes/modal.Rmd

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
22
title: "Modals"
3-
author: "Ian Lyttle"
4-
date: "`r Sys.Date()`"
5-
output: rmarkdown::html_vignette
63
---
74

85
```{r}

0 commit comments

Comments
 (0)