-
Notifications
You must be signed in to change notification settings - Fork 805
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1145 from quarto-dev/advanced-docs
Advanced Docs Landing Page
- Loading branch information
Showing
3 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "Environment Variables" | ||
summary: Environment variables Quarto inspects and sets | ||
format: html | ||
draft: true | ||
--- | ||
|
||
## Variables Quarto inspects | ||
|
||
These are variables that you can set to control how Quarto renders documents. For example, you can set them explicitly before running `quarto render`: | ||
|
||
``` {.bash filename="Terminal"} | ||
export QUARTO_R=/opt/R/4.2.3/bin | ||
quarto render | ||
``` | ||
|
||
You can read about other ways to set environment variables in Quarto Projects in [Environment Variables](/docs/projects/environment.qmd). | ||
|
||
| Variable | Description | | ||
|-----------------|-------------| | ||
| `QUARTO_R` | | | ||
| `QUARTO_PYTHON` | | | ||
| | | | ||
|
||
## Variables Quarto sets | ||
|
||
These variables are set by Quarto you can query them. For example, you can query them in an executable code cell: | ||
|
||
::: panel-tabset | ||
## R | ||
|
||
``` r | ||
Sys.getenv("QUARTO_DOCUMENT_PATH") | ||
``` | ||
|
||
## Python | ||
|
||
``` python | ||
import os | ||
print(os.environ["QUARTO_DOCUMENT_PATH"]) | ||
``` | ||
|
||
## Julia | ||
|
||
``` julia | ||
ENV["QUARTO_DOCUMENT_PATH"] | ||
``` | ||
::: | ||
|
||
| Variable | Description | | ||
|----------------|--------------------------------------------------------| | ||
| `QUARTO_PROJECT_ROOT` | Root of the project, or the directory of the file if not in project mode | | ||
| `QUARTO_DOCUMENT_PATH` | Directory of the document being rendered | | ||
| `QUARTO_PROFILE` | Profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production` | | ||
| `QUARTO_FIG_WIDTH` and `QUARTO_FIG_HEIGHT` | Values for `fig-width` and `fig-height` as set in the document metadata | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: "Advanced User Documentation" | ||
format: html | ||
search: false | ||
listing: | ||
type: table | ||
fields: [title, summary] | ||
field-display-names: | ||
summary: Summary | ||
--- | ||
|
||
Topics on this page may be of interest to advanced users of Quarto. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters