A pkgdown template for core tidyverse packages
Switch branches/tags
Nothing to show
Clone or download
hadley Merge pull request #35 from DavisVaughan/fix/dont-escape-html
Don't escape part_of and footer YAML params
Latest commit 842c2da Oct 16, 2018
Permalink
Failed to load latest commit information.
.github
R Render site locally for testing Sep 11, 2018
inst/pkgdown
man
scss CSS tweaks Oct 26, 2016
.Rbuildignore Render site locally for testing Sep 11, 2018
.gitignore
.travis.yml Build site with travis Sep 11, 2018
DESCRIPTION Add Github links Sep 11, 2018
LICENSE
NAMESPACE
README.Rmd
README.md Knit README. Oct 8, 2018
_pkgdown.yml Display version number in header Sep 12, 2018
tidytemplate.Rproj Initialise package Oct 24, 2016

README.md

tidytemplate

Travis build status Check accessibility

Overview

tidytemplate provides a custom pkgdown template for core tidyverse packages (i.e. packages hosted by the tidyverse organisation). Please don’t use it for your own package.

The theme is built on top of the paper bootswatch theme.

Using tidytemplate

Make sure your _pkgdown.yaml contains:

template:
  package: tidytemplate

development:
  mode: auto

home:
  strip_header: true

You can customise the “part of” in the header, and the footer text with template parameters:

template:
  package: tidytemplate
  params:
    part_of: tidymodels
    footer: ...

To work properly, tidytemplate requires the css files in inst/pkgdown/assets/. Because of this, you should not set default_assets: false in your _pkgdown.yaml.

template:
  package: tidytemplate
  # Do not do this!
  default_assets: false

If you deploy to github pages automatically using travis, add the following to your .travis.yml:

r_github_packages:
  - tidyverse/tidytemplate

CSS files

Three CSS files play a role in styling the site:

  • tidyverse.css is generated from files in scss/ written by Robby Shaver. Generally you should not touch these files; Robby is the owner. If needed you can regenerate tidyverse.css by running this code:

    # devtools::install_github("rstudio/sassr")
    library(sassr)
    compile_sass(
      "scss/tidyverse.scss",
      output = "inst/pkgdown/assets/tidyverse.css",
      options = sass_options(output_style = "nested")
    )
  • pkgdown.css comes from pkgdown.

  • tidyverse-2.css lives in inst/pkgdown/assets/tidyverse-2.css. Generally, this is the only file you should touch if you want to make changes to the style of the site.

Lorem Ipsum

Added to make the readme long enough that I can check scrolling.

Lorem ipsum dolor sit amet, ea pri paulo facete, in mel choro volumus. Dolore labitur cum no, vis copiosae appareat ex, vix antiopam iudicabit consequat in. Has equidem graecis et. Ea est partem altera, ius id agam debitis. Ex mea minim utroque, harum choro at has.

Vim rebum denique ad. Vocent dignissim ea qui, mea no vocent eruditi. At vix soleat bonorum comprehensam, qui nibh sale epicurei te, ex ullum dicta sit. Sed te vide nostrud. Denique delicata ut vim.

Nec no nobis scaevola, ad his commodo qualisque liberavisse. Sed porro propriae repudiare et, enim viris definitionem mei an. Ridens deserunt conceptam usu et. Cu has eros dicit, ex nec idque fabulas. Eum ei sensibus mnesarchum dissentias.

Eum id essent pericula salutandi, cu mazim congue molestiae usu. No has omnesque conclusionemque, no eos nusquam offendit expetendis. Alii oratio ad usu. Et pri feugait recusabo salutandi, ius ad commune salutandi. Ut graece vivendum vim, decore qualisque mediocritatem vix cu.

Ei nullam postea interesset vix, vix eu case fugit graeco, nec ut ponderum deserunt. Has ex amet neglegentur, eos et porro debet eirmod. Te pri lorem persius facilisis. Eos liber mentitum nominavi id.