3. How other projects do it¶
The projects below are open: their repositories show exactly how they are built. They were chosen because each does one part of the cycle unusually well. Repository contents were checked in November 2026.
3.1 Quarto books: R for Data Science and Geocomputation with Python¶
R for Data Science is written as one Quarto (.qmd) file per chapter, configured by _quarto.yml. A single GitHub Actions workflow, build_book.yaml, renders and publishes it. Results of code are stored in a committed _freeze folder, so CI does not have to rerun every computation for each edit; it reruns only chapters whose code changed. Geocomputation with Python goes further: separate workflows build the book on every push (main.yaml), build a preview for every pull request (pr.yml, netlify.yml), and the repository has a .devcontainer.json and .gitpod.yml, so a contributor can open a ready-made environment in the browser with everything installed. It also carries a CITATION.bib.
Quarto renders the same source to HTML and to PDF through LaTeX (Posit 2026).
3.2 Jupyter Book and MyST: The Turing Way¶
The Turing Way, a community handbook on reproducible research, is a Jupyter Book written in MyST Markdown. Its CI is a set of small, single-purpose checks: external_link_check.yml (with a lychee.toml) finds broken links; accessibility-alt-text-bot.yml asks for alternative text on images; validate_citation.yml checks the CITATION.cff; release-drafter.yml and .zenodo.json turn releases into citable, archived versions with DOIs; test-file-size.yml stops oversized images. Netlify builds a preview of every pull request, at an address made from the pull request’s number (deploy-preview-``<number>--the-turing-way.netlify.app, removed once the pull request closes), so reviewers read the changed book, not a diff. Contributors are credited through .all-contributorsrc.
Jupyter Book 2 is built on the MyST engine, which exports PDFs through either LaTeX or Typst from the same source (Executable Books 2026).
3.3 Manubot: papers written in the open¶
Manubot Rootstock is a template for writing a scholarly manuscript in Markdown on GitHub. Each push runs manubot.yaml, which rebuilds the manuscript as HTML and PDF and publishes it. Citations are written as identifiers, for example @doi:10.1371/journal.pcbi.1007128, and Manubot fetches the reference metadata itself (Himmelstein et al. 2019). Every version of the manuscript has its own permanent web address.
3.4 The Carpentries Workbench: lessons¶
The Carpentries lesson template keeps lessons as Markdown episodes with a config.yaml. Its workflows build the lesson in a container (docker_build_deploy.yaml), check pull requests before they are built (pr-preflight.yaml) and comment on each pull request with what changed in the rendered lesson (pr-comment.yaml). A .devcontainer gives a ready environment, and translations are managed with Crowdin.
3.5 LaTeX with a hosted editor¶
Many people who write in LaTeX use Overleaf, a browser editor with a live PDF beside the source and a rich-text view. Overleaf can sync a project with a GitHub repository on its paid plans; the source then lives in git and other tools can build from it. It produces a PDF, not web pages: a web version needs a separate converter.
3.6 Side by side¶
| Project | Source | Built by | Preview of changes | After publication |
|---|---|---|---|---|
| Sphinx site (Ch. 2) | reStructuredText | author’s computer | local build | edit button, issues button, rebuild and push |
| R for Data Science | Quarto | GitHub Actions | local render | push; CI rebuilds; frozen results |
| Geocomputation with Python | Quarto | GitHub Actions | Netlify per pull request | push or pull request; dev container |
| The Turing Way | MyST Markdown | CI and Netlify | Netlify per pull request | pull requests checked for links, alt text, file size; DOI releases |
| Manubot | Markdown | GitHub Actions | each commit is a version | push; citations by DOI |
| Carpentries | Markdown | GitHub Actions (container) | comment on pull request | pull request; preflight checks |
| Overleaf | LaTeX | Overleaf | live PDF | edit online; optional git sync (paid) |
How the projects in this chapter handle the editing cycle.