/markdowntemplates

:white_check_mark::small_red_triangle_down: A collection of alternate R markdown templates

Primary LanguageCSSOtherNOASSERTION

Build Status

A package of R markdown templates and knitr knit engine replacments

These are a set of alternate R markdown templates that do not use Bootstrap and do not include or rely on jQuery. These are primarily here for demonstration purposes but are also useful in and of themselves (it's always good to have choices). If you have a particular framework you like and it's not here, file an issue and I'll add it.

  • bulma (output: markdowntemplates::bulma) uses the Bulma CSS framework and has optional navlink YAML header elements and also has support for arbitrary footer content & a subset of OpenGraph tags (see the example Rmd) which will be used in header of the generated file.
  • skeleton (output: markdowntemplates::skeleton) or default (output: markdowntemplates::default) uses the Skeleton CSS framework and has optional navlink YAML header elements and also has support for arbitrary footer content & a subset of OpenGraph tags (see the example Rmd) which will be used in header of the generated file.
  • kube (output: markdowntemplates::kube) uses the Kube CSS framework (contributed by Kieran Healy)
  • minimal (output: markdowntemplates::minimal) uses no CSS framework and only uses the title YAML header element.
  • hugo (output: markdowntemplates::hugo) produces markdown suitable for Hugo websites. It makes a broad assumption that you will save/use the hugo document in the content directory of your Hugo websites.

When you use RStudio to create a new R Markdown document, select "From Template" and choose one of these templates.

knit engine replacements

  • to_jupyter() : uses notedown to make an ipynb out of an Rmd

Installation

Since the package is not on CRAN yet, you have to install it from GitHub.

if (!("devtools" %in% installed.packages())){
  install.packages("devtools")
}

devtools::install_github("hrbrmstr/markdowntemplates")

Releases

  • 0.3.4.9000 TOC basic formattingin Bulma (and re-enabled TOC in general)
  • 0.3.3.9000 Replicate Bulma functionality in Skeleton/default; added supported YAML frontmatter to template functions docs
  • 0.3.2.9000 Basic template tests; rmarkdown::render examples added to template functions
  • 0.3.1.9000 Passes CRAN checks
  • 0.3.0.9000 Kube framework contributed by Kieran Healy; preview images in help pages
  • 0.2.1.9000 arbitrary footer content can be specified in the YAML header
  • 0.2.0.9000 self_contained=FALSE now copies the custom CSS
  • 0.1.0.9000 Initial release

Bulma example

Skeleton/default example

Kube example

Minimal example