Skip to content

Commit

Permalink
Consistently use pkgdown.yml in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hadley committed Jul 15, 2022
1 parent f22d3f3 commit eaf47d4
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@
* pkgdown can now translate all the text that it generates (#1446): this means
that if you have a package where the docs are written in another language, you
can match all the pkgdown UI to provide a seamless experience to non-English
speakers. Activate the translations by setting the `lang` in `_pkgdown.yaml`:
speakers. Activate the translations by setting the `lang` in `_pkgdown.yml`:

```yaml
lang: fr
Expand All @@ -240,7 +240,7 @@
an issue and we'll help you get started.

* Template packages can now provide `inst/pkgdown/_pkgdown.yml` which is used
as a set of defaults for `_pkgdown.yaml`. It can be used to (e.g.) provide
as a set of defaults for `_pkgdown.yml`. It can be used to (e.g.) provide
author definitions, select Bootstrap version and define bslib variables,
and customise the sidebar, footer, navbar, etc. (#1499).

Expand Down
2 changes: 1 addition & 1 deletion R/build-articles.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#'
#' @section Index and navbar:
#' You can control the articles index and navbar with a `articles` field in
#' your `_pkgdown.yaml`. If you use it, pkgdown will check that all articles
#' your `_pkgdown.yml`. If you use it, pkgdown will check that all articles
#' are included, and will error if you have missed any.
#'
#' The `articles` field defines a list of sections, each of which
Expand Down
2 changes: 1 addition & 1 deletion R/figure.R
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ meta_figures <- function(meta = list()) {
#' ```
#'
#' @return
#' A list containing the entries from the `figures` field in `_pkgdown.yaml`
#' A list containing the entries from the `figures` field in `_pkgdown.yml`
#' (see [build_reference()]), with default values added. Computed `width` and
#' `height` values (in pixels) are also included.
#' @export
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This generates a `docs/` directory containing a website. Your `README.md` become

### pkgdown 2.0.0 and Bootstrap 5

pkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which is accompanied by a whole bunch of minor UI improvements. If you've heavily customised your site, there's a small chance that this will break your site, so everyone needs to explicitly opt-in to the upgrade by adding the following to `_pkgdown.yaml`:
pkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which is accompanied by a whole bunch of minor UI improvements. If you've heavily customised your site, there's a small chance that this will break your site, so everyone needs to explicitly opt-in to the upgrade by adding the following to `_pkgdown.yml`:

```yaml
template:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ pkgdown 2.0.0 includes an upgrade from Bootstrap 3 to Bootstrap 5, which
is accompanied by a whole bunch of minor UI improvements. If you’ve
heavily customised your site, there’s a small chance that this will
break your site, so everyone needs to explicitly opt-in to the upgrade
by adding the following to `_pkgdown.yaml`:
by adding the following to `_pkgdown.yml`:

``` yaml
template:
Expand Down
2 changes: 1 addition & 1 deletion man/build_articles.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/fig_settings.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions vignettes/customise.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ knitr::opts_chunk$set(
```

This vignette teaches you how to customise the style/design of your pkgdown site.
We'll start by discussing two techniques that only require tweaks to your `_pkgdown.yaml`: theming (colours and fonts) and layout (content of the navbar, sidebar, footer, ...).
We'll start by discussing two techniques that only require tweaks to your `_pkgdown.yml`: theming (colours and fonts) and layout (content of the navbar, sidebar, footer, ...).
We'll then discuss how to add additional HTML and other files.
Next, we'll discuss how to give multiple sites the same style using a package, then finish up with some workflow advice.

Expand All @@ -40,7 +40,7 @@ Upgrading to Bootstrap 5 has a low chance of breaking your site unless you were
## Theming
There are two ways to change the visual style of your site from `_pkgdown.yaml`: using a pre-packaged bootswatch theme or customising theme variables with bslib.
There are two ways to change the visual style of your site from `_pkgdown.yml`: using a pre-packaged bootswatch theme or customising theme variables with bslib.
The following sections show you how.

### Bootswatch themes
Expand Down
2 changes: 1 addition & 1 deletion vignettes/pkgdown.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You can also use `ends_with()` and `matches()`.
See complete details in `?build_reference`.

While iterating on the reference index you might want to run `pkgdown::build_reference_index()`.
It just re-builds the index page, making it faster to quickly change `_pkgdown.yaml` and see how it affects your site.
It just re-builds the index page, making it faster to quickly change `_pkgdown.yml` and see how it affects your site.

## Articles

Expand Down

0 comments on commit eaf47d4

Please sign in to comment.