tar_notebook: Assemble knitted notebook md files into a single-page...

View source: R/tar-notebook.R

tar_notebookR Documentation

Assemble knitted notebook md files into a single-page bookdown document

Description

Assemble knitted notebook md files into a single-page bookdown document

Usage

tar_notebook(
  subdir_output = "docs",
  extra_deps = list(),
  use_downlit = FALSE,
  markdown_document2_args = list()
)

Arguments

subdir_output

Subdirectory of dir_md which will contain final html file produced by bookdown. Defaults to "docs".

extra_deps

A list of extra dependencies. These should be the names of targets defined elsewhere in the dependencies graph. Defaults to list(). Use this argument, for example, to force a notebook to depend on a .css file.

use_downlit

whether to post-process the notebook with the downlit syntax highlighter. Default is FALSE.

markdown_document2_args

arguments to pass onto bookdown::markdown_document2(). Defaults to list().

Details

The list of targets produced includes:

  • notebook_output_yaml, a file target for _output.yml (used by bookdown to set output format options).

  • notebook_bookdown_yaml, a file target for _bookdown.yml (used by bookdown to collate pages).

  • notebook, a file target for the final assembled html file used by bookdown.

The only output format supported is an html file produced by cleanrmd::html_document_clean().

Value

A list of targets.


tjmahr/tarnotes documentation built on June 19, 2022, 4:40 a.m.