https://github.com/tidyverse/tidytemplate
A pkgdown template for core tidyverse packages
https://github.com/tidyverse/tidytemplate
Last synced: 4 months ago
JSON representation
A pkgdown template for core tidyverse packages
- Host: GitHub
- URL: https://github.com/tidyverse/tidytemplate
- Owner: tidyverse
- License: other
- Created: 2016-10-24T19:17:37.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T19:47:27.000Z (12 months ago)
- Last Synced: 2024-08-13T07:15:47.064Z (8 months ago)
- Language: SCSS
- Homepage: https://tidytemplate.tidyverse.org
- Size: 5.32 MB
- Stars: 46
- Watchers: 7
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - tidyverse/tidytemplate - A pkgdown template for core tidyverse packages (SCSS)
README
---
output: github_document
---
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# tidytemplate 
[](https://github.com/tidyverse/tidytemplate/actions)
[](http://wave.webaim.org/report#/http://tidytemplate.tidyverse.org)
## Overview
tidytemplate provides a custom [pkgdown](https://pkgdown.r-lib.org) template for tidyverse, r-lib, tidymodels, and rmarkdown packages. Please don't use it for your own package.
## Templates
For all sites, ensure that `DESCRIPTION` contains:
```
Config/Needs/website: tidyverse/tidytemplate
```
### tidyverse and r-lib
```yaml
template:
package: tidytemplate
bootstrap: 5
includes:
in_header: |
development:
mode: auto
```
Ping Hadley on slack to get your site added to plausible.
### tidymodels
```yaml
template:
package: tidytemplate
bootstrap: 5
bslib:
primary: "#CA225E"
includes:
in_header: |
development:
mode: auto
```
Ping Hadley on slack to get your site added to plausible.
### rmarkdown / quillt
```yaml
template:
package: tidytemplate
bootstrap: 5
bslib:
primary: "#096B72"
navbar-background: "#e6f3fc"
trailing_slash_redirect: true
```
### Updating
If you're updating from a previous pkgdown config, use the following checklist to make sure everything is up to date:
````md
* [ ] `usethis::use_pkgdown_github_pages()`
* [ ] Ensure Author includes RStudio as copyright holder and funder
* [ ] Update `DESCRIPTION` to include `Config/Needs/website: tidyverse/tidytemplate`
* [ ] Update `_pkgdown.yml` with appropriate template above.
* [ ] Ping Hadley to add plausible.io record
* [ ] Remove `strip_header: true`
* [ ] Remove algolia search, if used
* [ ] Eliminate superseded navbar customisation (`home: ~`, article re-ordering)
* [ ] Update `news` structure if needed
* [ ] Remove any author info for tidyverse folks (since now included in template)
````