create_post_from_template: Create a new blog post from a template

In EllaKaye/distilltools: A collection of tools to assist in the creating and styling of content on {distill} websites

Create a new blog post from a template

Description

Create a new blog post from a template. This function can also be run interactively using the Create post (from template) RStudio addin.

Usage

create_post_from_template(
  path,
  title,
  collection = "posts",
  author = "auto",
  slug = "auto",
  date = Sys.Date(),
  date_prefix = date,
  draft = FALSE,
  edit = interactive()
)

Arguments

path	File path to .Rmd post template
title	Post title. If there is a title in the template, this will override it.
collection	Collection to create the post within (defaults to "posts")
author	Post author. If not provided, it will be automatically drawn from template. If not in template, it will be automatically drawn from previous post.
slug	Post slug (directory name). Automatically computed from title if not provided.
date	Post date (defaults to current date)
date_prefix	Date prefix for post slug (preserves chronological order for posts within the filesystem). Pass NULL for no date prefix.
draft	Mark the post as a draft (don't include it in the article listing).
edit	Open the post in an editor after creating it.

Details

The create_post_from_template function is designed to work as closely as possible to distill::create_post(). The main difference is the compulsory path argument, which gives the path of the R Markdown template to create the post from.

When running create_post_from_template interactively using the Create post (from template) RStudio addin, a list of available templates is provided to choose from through a dropdown menu. The contents of this list are retrieved using the available_templates() function, which looks for R Markdown post templates in ./templates by default. The global option distilltools.templates.path can be used to change the directory available_templates() looks in (See ?available_templates for details). In addition to local templates, the Create post (from template) RStudio addin will always make available a default template named "Default" that matches the one from distill::create_post().

Note

This function must be called from a working directory that is within a Distill website.

The output for a post must be distill::distill_article. If there is no output key in the provided template, this will be added to the yaml. If there is an output specified in the template yaml, it must be distill::distill_article, otherwise create_post_from_template will throw an error.

Unlike distill::create_post(), create_post_from_template doesn't automatically provide a description key in the yaml.

See Also

available_templates(), distill::create_post()

Examples

## Not run: 
library(distilltools)
# .Rmd templates stored in "templates" directory
create_post_from_template(
  path = "templates/post-template.Rmd",
  title = "My post from template"
)

## End(Not run)

EllaKaye/distilltools documentation built on Nov. 21, 2022, 12:22 p.m.