Question 1

How to customize a pkgdown site beyond the default theme?

Accepted Answer

Use the _pkgdown.yml file to modify Bootstrap settings, add custom CSS, or override templates. Check vignette("customise") for detailed examples, such as those from packages like bayesplot, which show advanced styling techniques.

Question 2

pkgdown vs other static site generators like Jekyll for R docs?

Accepted Answer

pkgdown is tailored for R packages, automatically converting R documentation and vignettes, whereas Jekyll requires manual setup and doesn't integrate with R's ecosystem. pkgdown saves time but is less flexible for non-R content.

Question 3

Can I deploy pkgdown without GitHub Actions?

Accepted Answer

Yes, use pkgdown::build_site() locally or in CI scripts (e.g., Travis CI) to generate the site, then upload the docs/ folder to any static host. The README mentions this but emphasizes GitHub for automation.

Question 4

How to add a blog or news section to a pkgdown site?

Accepted Answer

pkgdown doesn't have built-in blog functionality; you can create custom pages via _pkgdown.yml and write articles in vignettes, but for dynamic updates, consider linking to an external blog or using a separate tool.

Question 5

Does pkgdown support dark mode or accessibility features?

Accepted Answer

Bootstrap 5 templates include responsive design, but dark mode isn't natively supported. You can implement it with custom CSS, and accessibility relies on Bootstrap's defaults, which may require additional tweaks for compliance.

Question 6

How to handle large R packages with many functions in pkgdown?

Accepted Answer

pkgdown efficiently scales by generating a navigable reference index and search functionality. For example, tidyverse packages use it successfully, but you might need to optimize _pkgdown.yml for better organization.

staticdocs

What is staticdocs?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions