This repository is a Surrogate Science template for computational publications authored in Quarto. It supports Jupyter notebooks, executable Python or R content, reproducible figures, and a GitHub Pages HTML publication.
The template includes two separate themes built from the same Surrogate Science palette and type system:
- Warm Journal is the default. It uses Cormorant Garamond for editorial display, Assistant for interface text, and Fira for labels and code.
- Technical Notebook uses Assistant Semibold for technical display, a teal masthead, and Fira for labels and code.
Preview or render either theme explicitly:
make preview-warm
make preview-technical
make render-warm
make render-technicalFor CI or hosting, set QUARTO_PROFILE=technical-notebook to select Theme B. Without an explicit profile, Quarto uses warm-journal.
All the learning resources for this template can be found in developer-docs/.
- Quickstart Guide - The most efficient way to get started is to follow this guide (the rest can wait)
- CRediT Author Contributions - Collect author-approved roles and generate a contribution statement
- AI Usage Disclosure - Record required author statements and review confirmation in
ai-use.yml - Environment Setup Guide - How to set up your development environment
- Publishing Guide - How to publish your notebook publication
- Template Architecture - Understanding the template's structure
NOTE: When ready to publish, fill in the information below, then delete this line and everything above it.
This code repository contains or points to all materials required for creating and hosting the publication entitled, "[PUB-TITLE]".
The publication is hosted at this URL.
[DESCRIPTION OF THE DATA]
Please see SETUP.qmd.
Please see CONTRIBUTING.qmd.