yaml_body: Partition the YAML metadata and the body in a document

In xfun: Supporting Functions for Packages Maintained by 'Yihui Xie'

Partition the YAML metadata and the body in a document

Description

Split a document into the YAML metadata (which starts with ⁠---⁠ in the beginning of the document) and the body.

Usage

yaml_body(x, ..., parse = TRUE)

Arguments

x	A character vector of the document content.
...	Arguments to be passed to yaml_load().
parse	Whether to parse the YAML data.

Value

A list of components yaml (the YAML data), lines (starting and ending line numbers of YAML), and body (a character vector of the body text). If YAML metadata does not exist in the document, the components yaml and lines will be missing.

Examples

xfun::yaml_body(c("---", "title: Hello", "output: litedown::html_format", "---",
    "", "Content."))

xfun documentation built on April 3, 2025, 7:04 p.m.