Accessibility

pkgdown automates as many accessibility details as possible, so that your package website is readable by as many people as possible. This vignette describes the additional details that can’t be automated away and you need to be aware of.

library(pkgdown)

Theming

Images

To make your site fully accessible, the place where you are likely to need to do the most work is adding alternative text to any images that you create. Unfortunately, there’s currently no way to do this for plots you generate in examples, but you can and should add alternative text to plots in vignettes using the fig.alt chunk option:

```{r}
#| fig.alt: >
#|   Histogram of time between eruptions for Old Faithful. 
#|   It is a bimodal distribution with peaks at 50-55 and 
#|   80-90 minutes.
hist(faithful$waiting)
```

If you forget to add alt text to your vignettes, pkgdown will automatically remind you.