Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos #703

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos #703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions content/blog/pkgdown-2-1-0/index.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ You can install it from CRAN with:
install.packages("pkgdown")
```

This is a massive release with a bunch of new features. I'll highlight the most important here, but as always, I highlight recommend skimming the [release notes](https://github.com/r-lib/pkgdown/releases/tag/v2.1.0) for other smaller improvements and bug fixes.
This is a massive release with a bunch of new features. I'll highlight the most important here, but as always, I recommend skimming the [release notes](https://github.com/r-lib/pkgdown/releases/tag/v2.1.0) for other smaller improvements and bug fixes.

First, and most importantly, please join me in welcoming two new authors to pkgdown: [Olivier Roy](https://github.com/olivroy) and [Salim Brüggemann](https://github.com/salim-b). They have both contributed many improvements to the package and I'm very happy to officially have them aboard as package authors.

Expand All @@ -51,7 +51,7 @@ library(pkgdown)

## Lifecycle changes

Let's get started with the important stuff, the [lifecycle updates](https://www.tidyverse.org/blog/2021/02/lifecycle-1-0-0/). Most important we've decided to deprecate support for Bootstrap 3, which was superseded in December 2021. We're starting to more directly encourage folks to move away from it as maintaining two separate sets of site templates is a time sink. If you're still using BS3, now's the [time to upgrade](https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/#bootstrap-5).
Let's get started with the important stuff, the [lifecycle updates](https://www.tidyverse.org/blog/2021/02/lifecycle-1-0-0/). Most importantly, we've decided to deprecate support for Bootstrap 3, which was superseded in December 2021. We're starting to more directly encourage folks to move away from it as maintaining two separate sets of site templates is a time sink. If you're still using BS3, now's the [time to upgrade](https://www.tidyverse.org/blog/2021/12/pkgdown-2-0-0/#bootstrap-5).

There are three other changes that are less likely to affect folks:

Expand All @@ -75,9 +75,9 @@ Combining the individual quarto and pkgdown templating systems is a delicate art

pkgdown sites can now provide a "light switch" that allows the reader to switch between light and dark modes (based on work in bslib by [@gadenbuie](https://github.com/gadenbuie)). You can try it out on <https://pkgdown.r-lib.org>: the light switch appears at the far right at the navbar and remembers the users choice between visits to your site.

(Note that the light switch works differently to quarto dark mode. In quarto, you can provide two completely different themes for light and dark mode. In pkgdown, dark mode is a relatively thin overlay that based on your light theme colours.)
(Note that the light switch works differently to quarto dark mode. In quarto, you can provide two completely different themes for light and dark mode. In pkgdown, dark mode is a relatively thin overlay that's based on your light theme colours.)

For now, you'll need to opt-in to the light-switch by adding the following to your `_pkgdown.yml`:
For now, you'll need to opt-in to the light switch by adding the following to your `_pkgdown.yml`:

```yaml
template
Expand All @@ -96,13 +96,13 @@ We've made a bunch of small changes to enhance the user experience of pkgdown si

* `build_reference()` adds anchors to arguments making it possible to link directly to an argument. This is very useful when you're trying to direct folks to the documentation for a specific argument, e.g. <https://pkgdown.r-lib.org/reference/build_site.html#arg-devel>.

* `build_reference_index()` now displays function lifecycle badges [next to the function name](https://pkgdown.r-lib.org/reference/index.html#deprecated-functions). If you want to gather together (e.g.) all the deprecated function in one spot in the reference index, you can use the new topic selector `has_lifecycle("deprecated")`.
* `build_reference_index()` now displays function lifecycle badges [next to the function name](https://pkgdown.r-lib.org/reference/index.html#deprecated-functions). If you want to gather together (e.g.) all the deprecated functions in one spot in the reference index, you can use the new topic selector `has_lifecycle("deprecated")`.

* The new `template.math-rendering` option allows you to control how math is rendered on your site. The default uses `mathml` which is zero dependency but has the lowest fidelity. If you use a lot of math on your site, you can switch back to the previous method with `mathjax`, or try out `katex`, a faster alternative.
* The new `template.math-rendering` option allows you to control how math is rendered on your site. The default uses `mathml` which has zero dependencies but also has the lowest fidelity. If you use a lot of math on your site, you can switch back to the previous method with `mathjax`, or try out `katex`, a faster alternative.

* pkgdown sites no longer depend on external content distribution networks (CDN) for common javascript, CSS, and font files. CDNs no longer provide [any performance advantages](https://www.stefanjudis.com/notes/say-goodbye-to-resource-caching-across-sites-and-domains/) and make deployment harder inside certain locked-down corporate environments.

* pkgdown includes translations for more terms including "Abstract" and "Search site". A big thanks to @jplecavalier, @dieghernan, @krlmlr, @LDalby, @rich-iannone, @jmaspons, and @mine-cetinkaya-rundel for providing updated translations in French, Spanish, Portugese, Germna, Catalan, and Turkish!
* pkgdown includes translations for more terms including "Abstract" and "Search site". A big thanks to @jplecavalier, @dieghernan, @krlmlr, @LDalby, @rich-iannone, @jmaspons, and @mine-cetinkaya-rundel for providing updated translations in French, Spanish, Portugese, German, Catalan, and Turkish!

I've also written `vignette("translations")`, a brief vignette that discusses how translation works for non-English sites, and includes how you can create translations for new languages. (This is a great way to contribute to pkgdown if you are multi-lingual!)

Expand Down