Skip to content

[Early-Release] Automatic Code Appendices for Quarto Documents with or without results included sorted by language or order.

Notifications You must be signed in to change notification settings

coatless-quarto/regurgitate

Repository files navigation

regurgitate

The regurgitate Quarto extension collects code blocks and their execution results, placing them in a "Code Appendix" at the end of your document.

Installation

To install the regurgitate Quarto extension, follow these steps:

  1. Open your terminal.
  2. Execute the following command:
quarto add coatless-quarto/regurgitate

This command will download and install the Quarto extension under the _extensions subdirectory of your Quarto project. If you are using version control, ensure that you include this directory in your repository.

Usage

Add the regurgitate filter to your document's YAML front matter:

---
title: "My Document"
filters:
  - regurgitate
---

That's it! All code blocks will now appear in an appendix at the end.

Configuration

Three independent options control behavior:

extensions:
  regurgitate:
    group-by-language: false      # Group by programming language
    show-code-inline: true        # Show code in original positions
    show-output-results: true     # Include execution results in appendix

Option Details

  • group-by-language (default: false)
    • false: Appendix code in document order
    • true: Appendix grouped by language (Python, R, etc.)
  • show-code-inline (default: true)
    • true: Code appears both inline and in appendix
    • false: Code only in appendix (removed from inline)
  • show-output-results (default: true)
    • true: Include execution output in appendix
    • false: Only code in appendix (no output)

About

[Early-Release] Automatic Code Appendices for Quarto Documents with or without results included sorted by language or order.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages