LoginSign Up
← Back to all sparks
B

b3doc

INFRA · APIS
Velocity0.0

R package b3doc by b-cubed-eu — release notes from GitHub.

github.com/b-cubed-eu/b3doc ↗

A small B-Cubed utility for turning R Markdown into publishable docs

documentationrmarkdownstatic-sitebiodiversityb-cubedr-package
◆Current state
b3doc converts R Markdown to Markdown and rewrites front matter for documentation published by the B-Cubed project, which is its entire remit. Three releases exist: the initial pair of functions, a generalisation of the front-matter replacement, and a hardening pass that removed regex from the replace argument and standardised figures at 300 DPI. It sits in the b-cubed-eu family alongside impIndicator and shares contributors with the wider Belgian biodiversity tooling group.
◆Where it's heading
The direction is toward predictability over flexibility. The replace argument arrived in 0.2.0 generalising the earlier logo-specific behaviour, then 0.3.0 pulled regex support back out of it because escape characters and over-broad matches caused unintended edits. That is a maintainer choosing a narrower tool that fails obviously over a general one that fails quietly — a reasonable trade for a package that rewrites files in place.
◆Prediction
Expect continued small releases driven by the documentation pipeline's needs, with output-quality defaults and front-matter handling the likely subjects rather than new functions.

◆Recent moves

  1. 4mo ago

    Regex dropped from replace; figures standardised at 300 DPI

    The replace argument of update_frontmatter() stops interpreting regex, trading flexibility for the absence of escape-character surprises and accidental broad replacements in files edited on disk. Figures now render at 300 DPI by default, which is the change readers of the published documentation actually see.

    View source ↗
  2. 0y ago

    Front-matter replacement generalised beyond the logo

    update_frontmatter() learns to handle .md files and gains a general replace argument that swaps any key for a value, superseding the single-purpose logo argument. The generalisation here is what the following release partly walked back by removing regex support.

    View source ↗
  3. 1y ago

    Initial release: front-matter updates and Rmd-to-Markdown conversion

    The first release, establishing both functions the package still consists of: update_frontmatter() for rewriting front matter and logos in a Markdown file on disk, and rmd_to_md() for converting external R Markdown. Everything since has refined these two.

    View source ↗