What problem does it solve?
Ensures consistent, reproducible, and project-compliant Quarto document authoring across directories so authors do not duplicate inherited settings or break rendering and cross-references.
Core Features & Use Cases
- Configuration inheritance: Read and respect project-level _quarto.yml and directory _metadata.yml to avoid redundant overrides.
- Setup and pipeline integration: Guidance for including a setup chunk only when reading pipeline data and for setting themes and data-loading conventions.
- Tables and plots: Enforce gt-based tables with gt_theme_report(), fig-/tbl- chunk labels, and fig-cap/tbl-cap usage for cross-references.
- Markdown and citation rules: Require blank lines before block elements, forbid trailing horizontal rules, standardize citation placement and the References section.
- Code chunk conventions: Standardize chunk labels, execute/cache options, and dynamic markdown patterns to maintain reproducibility and readability.
- Use case: Preparing a reproducible project report that reads target pipeline data, produces labeled figures and tables, and renders consistently across team members.
Quick Start
When creating or editing a .qmd file, read the project _quarto.yml and the directory _metadata.yml first, then apply the guide's chunk, labeling, table, plot, markdown, and citation conventions.