Package 'postcards'

Title: Create Beautiful, Simple Personal Websites
Description: A collection of R Markdown templates for creating simple and easy to personalize single page websites.
Authors: Sean Kross [aut, cre]
Maintainer: Sean Kross <[email protected]>
License: MIT + file LICENSE
Version: 0.2.3
Built: 2024-10-12 06:41:46 UTC
Source: https://github.com/seankross/postcards

Help Index


Create a new postcard

Description

Create (and optionally edit) a new postcard.

Usage

create_postcard(
  file = "index.Rmd",
  template = "jolla",
  create_dir = FALSE,
  edit = TRUE,
  create_image = TRUE
)

Arguments

file

File name for the draft

template

Template to use as the basis for the draft. This is either the full path to a template directory or the name of a template directory within the rmarkdown/templates directory of a package.

create_dir

TRUE to create a new directory for the postcard (defaults to FALSE).

edit

TRUE to edit the template immediately

create_image

TRUE to create a placeholder image (defaults to TRUE).

Details

Valid values for the template argument include "jolla", "jolla-blue", "trestles", "onofre", and "solana".

Examples

## Not run: 

postcards::create_postcard(template = "jolla")
postcards::create_postcard(template = "jolla-blue")
postcards::create_postcard(template = "trestles")
postcards::create_postcard(template = "onofre")
postcards::create_postcard(template = "solana")

## End(Not run)

Postcards templates

Description

Postcards templates

Usage

jolla(css = NULL, includes = NULL, ...)

jolla_blue(css = NULL, includes = NULL, ...)

trestles(css = NULL, includes = NULL, ...)

onofre(css = NULL, includes = NULL, ...)

solana(css = NULL, includes = NULL, ...)

Arguments

css

CSS and/or Sass files to include. Files with an extension of .sass or .scss are compiled to CSS via sass::sass(). Also, if theme is a bslib::bs_theme() object, Sass code may reference the relevant Bootstrap Sass variables, functions, mixins, etc.

includes

Named list of additional content to include within the document (typically created using the includes function).

...

Additional arguments passed to rmarkdown::html_document()