Skip to content

Commit 3c2afa8

Browse files
cdervcderv
authored
Merge pull request #1542 from quarto-dev/envvars/chromium
2 parents 93cc08e + 36ad9db commit 3c2afa8

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

‎docs/advanced/environment-vars.qmd‎

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,29 @@ quarto render
1515

1616
You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd).
1717

18-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
19-
| Variable | Description |
20-
+==============================+==================================================================================================================================================================================================+
21-
| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. |
22-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
23-
| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. |
24-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
25-
| `QUARTO_JULIA` | Explicit path to the version of `julia` to be used by the `julia` engine. |
26-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
27-
| `QUARTO_VERSION_REQUIREMENT` | A [`semver`](https://semver.org/) string describing the Quarto version requested by the environment. If this check fails, Quarto will not run. |
28-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
29-
| `QUARTO_KNITR_RSCRIPT_ARGS` | Comma separated list of command line argument to pass to `Rscript` started by Quarto when rendering with `knitr` engine, e.g. |
30-
| | |
31-
| | ``` |
32-
| | QUARTO_KNITR_RSCRIPT_ARGS="--no-init-file,--max-connections=258" |
33-
| | ``` |
34-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
35-
| `QUARTO_TEXLIVE_BINPATH` | Explicit path to the TeX Live binaries to be passed to `tlmgr option sys_bin` used when setting `tlmgr` and related to `PATH` using `tlmgr add path` . By default, Quarto looks in known places. |
36-
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
18+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
19+
| Variable | Description |
20+
+=================================+==================================================================================================================================================================================================================================================================================================================+
21+
| `QUARTO_R` | Explicit path to the version of `Rscript` to be used by the `knitr` engine and `quarto run *.R` command. |
22+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
23+
| `QUARTO_PYTHON` | Explicit path to the version of `python` to be used by the `jupyter` engine and `quarto run *.py` command. |
24+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
25+
| `QUARTO_JULIA` | Explicit path to the version of `julia` to be used by the `julia` engine. |
26+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
27+
| `QUARTO_VERSION_REQUIREMENT` | A [`semver`](https://semver.org/) string describing the Quarto version requested by the environment. If this check fails, Quarto will not run. |
28+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
29+
| `QUARTO_KNITR_RSCRIPT_ARGS` | Comma separated list of command line argument to pass to `Rscript` started by Quarto when rendering with `knitr` engine, e.g. |
30+
| | |
31+
| | ``` |
32+
| | QUARTO_KNITR_RSCRIPT_ARGS="--no-init-file,--max-connections=258" |
33+
| | ``` |
34+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
35+
| `QUARTO_TEXLIVE_BINPATH` | Explicit path to the TeX Live binaries to be passed to `tlmgr option sys_bin` used when setting `tlmgr` and related to `PATH` using `tlmgr add path` . By default, Quarto looks in known places. |
36+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
37+
| `QUARTO_CHROMIUM` | Explicit path to binary to use for chrome headless. Quarto uses [Chrome Devtools Protocol](https://chromedevtools.github.io/devtools-protocol/) to do screenshot of HTML diagrams for PDF insertion. The binary must be compatible with this protocol. (e.g. Chrome, Chromium, Chrome Headless Shell, Edge, ...) |
38+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
39+
| `QUARTO_CHROMIUM_HEADLESS_MODE` | Used for adaption of the `--headless` mode used with `QUARTO_CHROMIUM` binary. Set to `"none"` for `--headless` , or to `"old"` or `"new"` to pass as argument, e.g. `--headless=<QUARTO_CHROMIUM_HEADLESS_MODE>` . Quarto 1.6 sets `"old"` as default, which works from Chrome 112 to 131. |
40+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
3741

3842
## Variables Quarto sets
3943

@@ -60,17 +64,16 @@ ENV["QUARTO_DOCUMENT_PATH"]
6064
```
6165
:::
6266

63-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
64-
| Variable | Description |
65-
+============================================+==========================================================================================================+
66-
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode |
67-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
68-
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered |
69-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
70-
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` |
71-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
72-
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata |
73-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
74-
| `QUARTO_RUN_NO_NETWORK` | When `true`, Quarto project scripts written in TypeScript won't be allowed to use the network to |
75-
| | download sources. In this setting, those scripts will not have access to the standard library. |
76-
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
67+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
68+
| Variable | Description |
69+
+============================================+=================================================================================================================================================================================================+
70+
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode |
71+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
72+
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered |
73+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
74+
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` |
75+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
76+
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata |
77+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
78+
| `QUARTO_RUN_NO_NETWORK` | When `true`, Quarto project scripts written in TypeScript won't be allowed to use the network to download sources. In this setting, those scripts will not have access to the standard library. |
79+
+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)