frontmatter

frontmatter-package

Extracts and parses YAML or TOML front matter from text documents.
Front matter is structured metadata at the beginning of a document,
delimited by fences.

internal

Extracts and parses structured metadata ('YAML' or 'TOML')
from the beginning of text documents. Front matter is a common pattern
in 'Quarto' documents, 'R Markdown' documents, static site generators,
documentation systems, content management tools and even 'Python' and
'R' scripts where metadata is placed at the top of a document,
separated from the main content by delimiter fences.

Garrick Aden-Buie

Parse Front Matter from Documents

Posit Software, PBC 

frontmatter-package function

<ul>
<li>Standard YAML (<code>---</code> delimiters)</li>
<li>Standard TOML (<code>+++</code> delimiters)</li>
<li>Comment-wrapped formats for R/Python files (<code>#</code> and <code>#'</code> prefixes)</li>
<li>PEP 723 Python inline script metadata</li>
</ul>

Supported Formats

<ul>
<li><code>parse_front_matter()</code>: Parse front matter from a string</li>
<li><code>read_front_matter()</code>: Parse front matter from a file</li>
</ul>

Main Functions

Uses C++11 for fast, single-pass parsing with minimal memory overhead.
Designed for high throughput processing of many documents.

Performance

Maintainer: Garrick Aden-Buie <a href="/link/garrick%40posit.co?package=frontmatter&version=0.2.0" data-mini-rdoc="frontmatter::garrick@posit.co">garrick@posit.co</a> (<a href="https://orcid.org/0000-0002-7111-0077">ORCID</a>)
Other contributors:<ul>
<li>Posit Software, PBC (<a href="https://ror.org/03wc8by49">ROR</a>) [copyright holder, funder]</li>
</ul>

Author

frontmatter: Parse Front Matter from Documents — frontmatter-package

<ul>
<li>Standard YAML (<code>---</code> delimiters)</li>
<li>Standard TOML (<code>+++</code> delimiters)</li>
<li>Comment-wrapped formats for R/Python files (<code>#</code> and <code>#'</code> prefixes)</li>
<li>PEP 723 Python inline script metadata</li>
</ul>

<ul>
<li><code>parse_front_matter()</code>: Parse front matter from a string</li>
<li><code>read_front_matter()</code>: Parse front matter from a file</li>
</ul>

Uses C++11 for fast, single-pass parsing with minimal memory overhead.
Designed for high throughput processing of many documents.

Maintainer: Garrick Aden-Buie <a href='mailto:garrick@posit.co'>garrick@posit.co</a> (<a href='https://orcid.org/0000-0002-7111-0077'>ORCID</a>)
Other contributors:<ul>
<li>Posit Software, PBC (<a href='https://ror.org/03wc8by49'>ROR</a>) [copyright holder, funder]</li>
</ul>

frontmatter-package: frontmatter: Parse Front Matter from Documents

Description

Arguments

Supported Formats

Main Functions

Performance

Author

See Also