package_readme: Copies individual files from package to Quarto

In edgararuiz/convertsite: Converts full sites, and package documentation to Quarto

Description

Copies individual files from package to Quarto

Usage

package_readme(
  pkg_folder = "",
  target = "",
  file_names = c("readme.md"),
  project_folder = "",
  root_folder = here::here()
)

package_news(
  pkg_folder = "",
  target = "",
  file_names = c("news.md", "news.Rmd"),
  project_folder = "",
  root_folder = here::here()
)

package_file_copy(
  pkg_folder = "",
  target = "project_folder",
  file_names = c("name.md", "name.Rmd"),
  override_name = NULL,
  project_folder = "",
  root_folder = here::here()
)

Arguments

pkg_folder	Path to the package's source code
target	Sub folder in project_folder where the output file will land
file_names	A vector of one or many file names. If it is multiple files the function will look for and use the first available.
project_folder	Sub folder in root_folder that will be the base for the package's documentation.
root_folder	Base target Quarto folder. Defaults to current workspace.
override_name	File name of the output, in case the original file name needs to be changed.

edgararuiz/convertsite documentation built on Dec. 20, 2021, 3:19 a.m.