Skip to content

Commit

Permalink
tweak wording
Browse files Browse the repository at this point in the history
  • Loading branch information
cscheid committed Feb 17, 2024
1 parent 68a4902 commit 626cebc
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions dev-docs/internals-guide/render.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ Read the [engines documentation](./engines/index.qmd) for more.
1. `knitr` takes Markdown as input
1. Run Pandoc

As an additional option, both engines can take script files formatted in a particular way
instead of a regular input. See [Render Scripts](https://quarto.org/docs/computations/render-scripts.html).

## Pandoc: Quarto's filter chain, user filters

Quarto choreographs a large number of Pandoc parameters and settings.
Expand All @@ -38,7 +41,7 @@ Read the [Pandoc directory](./pandoc/index.qmd) for more.
1. Determine output format(s)
1. Run Pandoc (one or more times per .qmd file)
1. Use Quarto's custom `.qmd` reader to support Quarto-specific Markdown syntax
1. Run Quarto's filter chain and user filters to control the generation of the documentation
1. Run Quarto's filter chain and user filters to control the generation of the document

## TypeScript cell handlers and includes

Expand All @@ -51,7 +54,7 @@ Include shortcodes, mermaid, dot, ojs.
1. Run other typescript-specific cell handlers
1. Run Pandoc
1. Use Quarto's custom `.qmd` reader to support Quarto-specific Markdown syntax
1. Run Quarto's filter chain and user filters to control the generation of the documentation
1. Run Quarto's filter chain and user filters to control the generation of the document

## Postprocessors

Expand All @@ -66,8 +69,26 @@ See the [Postprocessors documentation](./postprocessors/index.qmd) for more.
1. Run other typescript-specific cell handlers
1. Run Pandoc
1. Use Quarto's custom `.qmd` reader to support Quarto-specific Markdown syntax
1. Run Quarto's filter chain and user filters to control the generation of the documentation
1. Run Quarto's filter chain and user filters to control the generation of the document
1. Post-process outputs

## Output Recipes

Formats like PDF, Typst, and Beamer need an additional step after the postprocessors; this step
is handled in "Output Recipes".
This is a simple step that either calls the correct binary (`latexmk`, `pdflatex`, `typst` etc) or
does no work (in formats like `html` or `revealjs`)

1. Expand include shortcodes in .qmd inputs
1. Execute code cells from engine
1. `jupyter` takes both `.ipynb` and `.qmd` files as input.
1. `knitr` takes Markdown as input
1. Run other typescript-specific cell handlers
1. Run Pandoc
1. Use Quarto's custom `.qmd` reader to support Quarto-specific Markdown syntax
1. Run Quarto's filter chain and user filters to control the generation of the document
1. Post-process outputs
1. Generate final output file from output recipe

## Projects vs single-file renders

Expand Down

0 comments on commit 626cebc

Please sign in to comment.