nhs-r-community / NHSRplotthedots

An SPC package to support NHSE/I 'Making Data Count' programme
https://nhs-r-community.github.io/NHSRplotthedots/
Other
47 stars 21 forks source link

Upgrade pkgdown to bootstrap 5 #223

Closed francisbarton closed 3 weeks ago

francisbarton commented 1 month ago

pkgdown comes with a refreshed template that uses Bootstrap 5, a major update over the previous Bootstrap 3. (Bootstrap is the collection of HTML, CSS, and JS files that give pkgdown sites their basic style). Because this is a major change, you’ll need to opt-in by setting the boostrap version in your _pkgdown.yml:

template:
  bootstrap: 5

The old Bootstrap 3 template is superseded; it will continue to work for some time, but it won’t gain any new features and we encourage you to switch to the new template the next time you’re working on your package.

The new theme includes:

  • A number of minor improvements to accessibility, including a larger font size, greater use of aria attributes, and an accessible syntax highlighting colour scheme, designed by Alison Hill.

  • Support for new features like in-line footnotes and tabsets in articles.

  • Since so many packages have lovely logos, the package logo is now displayed on every page and made even more prominent on the home page.

As an added incentive to upgrade your template to Bootstrap 5, you’ll get site search for “free”: pkgdown now supports searching with no external dependencies and no setup. Learn more in vignette("search").

link

francisbarton commented 3 weeks ago

Closed by #228