Skip to content

Update reference pages (prerelease) #2146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 1 commit into from
Closed

Update reference pages (prerelease) #2146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,223 changes: 832 additions & 391 deletions docs/cli/cli-info.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia-close.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia close <file:string>
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia-kill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia kill
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia-log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia log
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia status
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia-stop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia stop
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/includes/_call-engine-julia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ quarto call engine julia
<tr>
<td style="text-align:left;"> <code>--log-level</code> </td>
<td style="text-align:left;"> <code><level></code> </td>
<td style="text-align:left;"> Log level (info, warning, error, critical) </td>
<td style="text-align:left;"> Log level (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
Expand Down
11 changes: 10 additions & 1 deletion docs/cli/includes/_call-engine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Access functionality specific to quarto's different rendering engines.

``` {.bash}
quarto call engine <engine-name:string> [args...:string]
quarto call engine
```


Expand Down Expand Up @@ -43,6 +43,11 @@ quarto call engine <engine-name:string> [args...:string]
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Suppress console output. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--profile</code> </td>
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Active project profile(s) </td>
</tr>
</tbody>
</table>
```
Expand All @@ -65,6 +70,10 @@ quarto call engine <engine-name:string> [args...:string]
<td style="text-align:left;"> <code>help</code> </td>
<td style="text-align:left;"> Show this help or the help of a sub-command. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>julia</code> </td>
<td style="text-align:left;"> Access functionality specific to the julia rendering engine. </td>
</tr>
</tbody>
</table>
```
Expand Down
22 changes: 0 additions & 22 deletions docs/cli/includes/_call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,28 +49,6 @@ quarto call
<td style="text-align:left;"> <code>engine</code> </td>
<td style="text-align:left;"> Access functionality specific to quarto's different rendering engines. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>build-ts-extension</code> </td>
<td style="text-align:left;"> Build TypeScript execution engine extensions.

This command type-checks and bundles TypeScript extensions into single JavaScript files using Quarto's bundled deno bundle.

The entry point is determined by:
1. [entry-point] command-line argument (if specified)
2. bundle.entryPoint in deno.json (if specified)
3. Single .ts file in src/ directory
4. src/mod.ts (if multiple .ts files exist) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>typst-gather</code> </td>
<td style="text-align:left;"> Gather Typst packages for a format extension.

This command scans Typst files for @preview imports and downloads the packages to a local directory for offline use.

Configuration is determined by:
1. typst-gather.toml in current directory (if present)
2. Auto-detection from _extension.yml (template and template-partials) </td>
</tr>
</tbody>
</table>
```
Expand Down
46 changes: 23 additions & 23 deletions docs/cli/includes/_cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
|Command |Description |
|:------------|:-----------------------------------------------------------------------------------------------------------|
|[render](render.qmd)|Render files or projects to various document types. |
|[preview](preview.qmd)|Render and preview a document or website project. |
|[serve](serve.qmd)|Serve a Shiny interactive document. |
|[create](create.qmd)|Create a Quarto project or extension |
|[use](use.qmd)|Automate document or project setup tasks. |
|[add](add.qmd)|Add an extension to this folder or project |
|[update](update.qmd)|Updates an extension or global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF). |
|[remove](remove.qmd)|Removes an extension. |
|[convert](convert.qmd)|Convert documents to alternate representations. |
|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. |
|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. |
|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. |
|[list](list.qmd)|Lists an extension or global dependency. |
|[install](install.qmd)|Installs a global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF). |
|[uninstall](uninstall.qmd)|Uninstalls a global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF). |
|[tools](tools.qmd)|Display the status of Quarto installed dependencies |
|[publish](publish.qmd)|Publish a document or project to a provider. |
|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) |
|[inspect](inspect.qmd)|Inspect a Quarto project or input path. |
|[check](check.qmd)|Verify correct functioning of Quarto installation. |
|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. |
|Command |Description |
|:------------|:--------------------------------------------------------------------|
|[render](render.qmd)|Render files or projects to various document types. |
|[preview](preview.qmd)|Render and preview a document or website project. |
|[serve](serve.qmd)|Serve a Shiny interactive document. |
|[create](create.qmd)|Create a Quarto project or extension |
|[use](use.qmd)|Automate document or project setup tasks. |
|[add](add.qmd)|Add an extension to this folder or project |
|[update](update.qmd)|Updates an extension or global dependency. |
|[remove](remove.qmd)|Removes an extension. |
|[convert](convert.qmd)|Convert documents to alternate representations. |
|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. |
|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. |
|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. |
|[list](list.qmd)|Lists an extension or global dependency. |
|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). |
|[uninstall](uninstall.qmd)|Removes an extension. |
|[tools](tools.qmd)|Display the status of Quarto installed dependencies |
|[publish](publish.qmd)|Publish a document or project to a provider. |
|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) |
|[inspect](inspect.qmd)|Inspect a Quarto project or input path. |
|[check](check.qmd)|Verify correct functioning of Quarto installation. |
|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. |
6 changes: 3 additions & 3 deletions docs/cli/includes/_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Installs a global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF).
Installs a global dependency (TinyTex or Chromium).

``` {.bash}
quarto install [target...]
Expand Down Expand Up @@ -93,10 +93,10 @@ quarto install [target...]
quarto install tinytex
```

### Install Chrome Headless Shell
### Install Chromium

``` {.bash filename='Terminal'}
quarto install chrome-headless-shell
quarto install chromium
```

### Choose tool to install
Expand Down
7 changes: 0 additions & 7 deletions docs/cli/includes/_publish.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Available providers include:
- Quarto Pub (quarto-pub)
- GitHub Pages (gh-pages)
- Posit Connect (connect)
- Posit Connect Cloud (posit-connect-cloud)
- Netlify (netlify)
- Confluence (confluence)
- Hugging Face Spaces (huggingface)
Expand Down Expand Up @@ -168,12 +167,6 @@ quarto publish connect
quarto publish connect --server example.com --token 01A24233E294
```

### Publish project to Posit Connect Cloud

``` {.bash filename='Terminal'}
quarto publish posit-connect-cloud
```

### Publish without confirmation prompt

``` {.bash filename='Terminal'}
Expand Down
12 changes: 3 additions & 9 deletions docs/cli/includes/_uninstall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Uninstalls a global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF).
Removes an extension.

``` {.bash}
quarto uninstall [tool]
Expand Down Expand Up @@ -87,15 +87,9 @@ quarto uninstall [tool]


## Examples
### Uninstall TinyTeX
### Remove extension using name

``` {.bash filename='Terminal'}
quarto uninstall tinytex
```

### Uninstall Chrome Headless Shell

``` {.bash filename='Terminal'}
quarto uninstall chrome-headless-shell
quarto remove <extension-name>
```

6 changes: 3 additions & 3 deletions docs/cli/includes/_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Updates an extension or global dependency (TinyTeX, Chromium (deprecated), Chrome Headless Shell, VeraPDF).
Updates an extension or global dependency.

``` {.bash}
quarto update [target...]
Expand Down Expand Up @@ -111,10 +111,10 @@ quarto update extension <url>
quarto update tool tinytex
```

### Update Chrome Headless Shell
### Update Chromium

``` {.bash filename='Terminal'}
quarto update tool chrome-headless-shell
quarto update tool chromium
```

### Choose tool to update
Expand Down
5 changes: 5 additions & 0 deletions docs/cli/includes/_use-binder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ quarto use binder
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Suppress console output. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--profile</code> </td>
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Active project profile(s) </td>
</tr>
</tbody>
</table>
```
Expand Down
4 changes: 0 additions & 4 deletions docs/cli/includes/_use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,6 @@ quarto use <type:string> [target:string]
<td style="text-align:left;"> <code>binder</code> </td>
<td style="text-align:left;"> Configure the current project with Binder support. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>brand</code> </td>
<td style="text-align:left;"> Use a brand for this project. </td>
</tr>
</tbody>
</table>
```
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/cells/cells-jupyter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2281,7 +2281,6 @@
"name": "cap-location",
"description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -2303,7 +2302,6 @@
"name": "fig-cap-location",
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -2326,7 +2324,6 @@
"name": "tbl-cap-location",
"description": "Where to place table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/cells/cells-knitr.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4345,7 +4345,6 @@
"name": "cap-location",
"description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -4367,7 +4366,6 @@
"name": "fig-cap-location",
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -4390,7 +4388,6 @@
"name": "tbl-cap-location",
"description": "Where to place table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand Down
3 changes: 0 additions & 3 deletions docs/reference/cells/cells-ojs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2107,7 +2107,6 @@
"name": "cap-location",
"description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -2129,7 +2128,6 @@
"name": "fig-cap-location",
"description": "Where to place figure captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand All @@ -2152,7 +2150,6 @@
"name": "tbl-cap-location",
"description": "Where to place table captions (`top`, `bottom`, or `margin`)",
"formats": [
"typst",
"dashboard",
"html",
"html4",
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/formats/asciidoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,16 @@
}
]
},
{
"name": "layout",
"title": "Layout",
"options": [
{
"name": "grid",
"description": "Properties of the grid system used to layout Quarto HTML pages."
}
]
},
{
"name": "code",
"title": "Code",
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/context.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
},
{
"name": "linestretch",
"description": "For HTML output sets the CSS `line-height` property on the html\nelement, which is preferred to be unitless.\n\nFor LaTeX output, adjusts line spacing using the\n[setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.\n\nFor Typst output, adjusts the spacing between lines of text.\n"
"description": "For HTML output sets the CSS `line-height` property on the html \nelement, which is preferred to be unitless.\n\nFor LaTeX output, adjusts line spacing using the \n[setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.\n"
},
{
"name": "interlinespace",
Expand All @@ -135,7 +135,7 @@
"options": [
{
"name": "linkcolor",
"description": "For HTML output, sets the CSS `color` property on all links.\n\nFor LaTeX output, The color used for internal links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor),\nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor ConTeXt output, sets the color for both external links and links within the document.\n\nFor Typst output, sets the color of internal hyperlinks using Typst color syntax.\n"
"description": "For HTML output, sets the CSS `color` property on all links.\n\nFor LaTeX output, The color used for internal links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor ConTeXt output, sets the color for both external links and links within the document.\n"
},
{
"name": "contrastcolor",
Expand All @@ -151,6 +151,10 @@
"name": "layout",
"description": "The options for margins and text layout for this document.\n\nSee [ConTeXt Layout](https://wiki.contextgarden.net/Layout) for additional information.\n"
},
{
"name": "grid",
"description": "Properties of the grid system used to layout Quarto HTML pages."
},
{
"name": "margin-left",
"description": "For HTML output, sets the `margin-left` property on the Body element.\n\nFor LaTeX output, sets the left margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the left margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the left page margin.\n"
Expand Down
Loading