FR: separate the customise vignette in 2: 1.theme your site and 2. customise navigation of your site

[olivroy]

As theming is different and only affects the template: part of the _pkgdown.yml file.

A lot of the customisation is pkgdown.Rmd, but possibly this vignette could be made shorter.

I am trying to put together a list of all fields accepted in _pkgdown.yml and try to document as much as possible in a single place, so that when you are trying to customize one part, you have a starting point that takes you to the correct place.

Is there such a list already in the docs?

Here is what I found so far.

intro:
navbar:
reference:
articles:
search:
lang:
home:
url:
destdir:
redirects:
navbar:
news:
template:

Also check_pkgdown() doesn't inform if it finds an unkown field and silently ignores it

[hadley]

The way I think about this vignette is slightly different. Where ever we have a build_x function, then the documentation for x: will live in that function. But there's a bunch of stuff that doesn't have a corresponding build_ function, because it affects every page (i.e. there's no build_navbar() or build_template()), so that goes either in the customise vignette or build_site(). It's not super clear to me why something would be documentation in build_site() vs vignette("customise") but I think the general theme is that the less commonly used details should live in build_site() so that the vignette can focus on the most commonly used bits.

Maybe the vignette should state that up front, including links to the most important build_ functions?