Quarto publication layer

BNR info-hub Technical Manual

1 Quarto publication layer

1.1 Purpose

This page explains how Quarto is used to publish the BNR info-hub.

Quarto is the publication layer. It turns approved outputs, narrative text, figures, downloads, and documentation into a static website.

1.2 What Quarto does

Quarto creates:

  • website pages
  • static briefing pages
  • technical documentation
  • operations manual pages
  • PDF briefings via Typst
  • release catalogue pages
  • dashboard pages, if added later

1.3 What Quarto should not do

Quarto should not replace Stata as the analytics engine.

Production Quarto pages should not contain hidden analytical logic that changes published BNR results. They should publish, explain, or link to outputs already created by the compute layer.

1.4 Site source and site output

The Quarto source lives in:

site/

The rendered site is created in:

site/_site/

Do not edit _site/ manually. It is generated output and ignored by Git.

1.5 Main publication folders

site/
├── surveillance/
├── methods-data/
├── downloads/
├── operations-manual/
├── technical/
└── assets/

1.6 Static briefing pages

The HTML and PDF versions of a briefing may use separate QMD files.

Example:

site/surveillance/cvd/briefings/
├── case-counts.qmd
└── case-counts-pdf.qmd

This is intentional. The HTML and PDF outputs have different layout needs.

1.7 HTML briefing role

The HTML page should:

  • explain the briefing
  • display the Stata-generated figures
  • summarise findings
  • link to public CSV files
  • link to metadata and build records
  • link to the PDF briefing

1.8 PDF briefing role

The PDF QMD should:

  • create a compact formal briefing
  • use the same approved figures
  • avoid web-only download cards
  • avoid hidden analysis
  • be suitable for email, print, and formal sharing

1.9 Download files

Stata-generated public outputs are copied into:

site/downloads/files/briefings/{briefing_id}/

The HTML pages and release catalogue link to this site-accessible copy.

1.10 Render commands

Preview the whole site:

cd C:\yoshimi-hot\output\analyse-bnr\info-hub\site
quarto preview --port 4200

Render the whole site:

cd C:\yoshimi-hot\output\analyse-bnr\info-hub\site
quarto render

Render one PDF briefing:

cd C:\yoshimi-hot\output\analyse-bnr\info-hub\site
quarto render surveillance/cvd/briefings/case-counts-pdf.qmd --to typst

1.11 Design principle

Use cards, grids, callouts, and clean headings for HTML pages.

Use a tighter, more formal layout for PDFs.

Do not force one QMD file to do everything if it makes the file hard to maintain.

Back to top