Skip to content

V1.9-update-reference #1882

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

Draft
cwickham wants to merge 2 commits into
base: prerelease
Choose a base branch
from
Draft

V1.9-update-reference #1882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
093991a
Update reference pages based on 1.9.22
cwickham Feb 19, 2026
99746b3
Update cli ref
cwickham Feb 19, 2026
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
4 changes: 4 additions & 0 deletions docs/cli/call.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,7 @@ shift-heading-level-by: 1
# call build-ts-extension

{{< include includes/_call-build-ts-extension.md >}}

# call typst gather

{{< include includes/_call-typst-gather.md >}}
176 changes: 166 additions & 10 deletions docs/cli/cli-info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.9.16",
"version": "1.9.22",
"commands": [
{
"name": "render",
Expand Down Expand Up @@ -1532,7 +1532,7 @@
{
"name": "update",
"hidden": false,
"description": "Updates an extension or global dependency.",
"description": "Updates an extension or global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF).",
"options": [
{
"standalone": true,
Expand Down Expand Up @@ -1682,7 +1682,11 @@
"description": "quarto update tool tinytex"
},
{
"name": "Update Chromium",
"name": "Update Chrome Headless Shell",
"description": "quarto update tool chrome-headless-shell"
},
{
"name": "Update Chromium (legacy)",
"description": "quarto update tool chromium"
},
{
Expand Down Expand Up @@ -2981,7 +2985,7 @@
{
"name": "install",
"hidden": false,
"description": "Installs a global dependency (TinyTex or Chromium).",
"description": "Installs a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF).",
"options": [
{
"standalone": true,
Expand Down Expand Up @@ -3110,7 +3114,11 @@
"description": "quarto install tinytex"
},
{
"name": "Install Chromium",
"name": "Install Chrome Headless Shell",
"description": "quarto install chrome-headless-shell"
},
{
"name": "Install Chromium (legacy)",
"description": "quarto install chromium"
},
{
Expand Down Expand Up @@ -3151,7 +3159,7 @@
{
"name": "uninstall",
"hidden": false,
"description": "Removes an extension.",
"description": "Uninstalls a global dependency (TinyTeX, Chromium, Chrome Headless Shell, VeraPDF).",
"options": [
{
"standalone": true,
Expand Down Expand Up @@ -3276,8 +3284,16 @@
"usage": "[tool]",
"examples": [
{
"name": "Remove extension using name",
"description": "quarto remove <extension-name>"
"name": "Uninstall TinyTeX",
"description": "quarto uninstall tinytex"
},
{
"name": "Uninstall Chrome Headless Shell",
"description": "quarto uninstall chrome-headless-shell"
},
{
"name": "Uninstall Chromium (legacy)",
"description": "quarto uninstall chromium"
}
],
"commands": [
Expand Down Expand Up @@ -3373,7 +3389,7 @@
{
"name": "publish",
"hidden": false,
"description": "Publish a document or project to a provider.\n\nAvailable providers include:\n\n - Quarto Pub (quarto-pub)\n - GitHub Pages (gh-pages)\n - Posit Connect (connect)\n - Netlify (netlify)\n - Confluence (confluence)\n - Hugging Face Spaces (huggingface)\n\nAccounts are configured interactively during publishing.\nManage/remove accounts with: quarto publish accounts",
"description": "Publish a document or project to a provider.\n\nAvailable providers include:\n\n - Quarto Pub (quarto-pub)\n - GitHub Pages (gh-pages)\n - Posit Connect (connect)\n - Posit Connect Cloud (posit-connect-cloud)\n - Netlify (netlify)\n - Confluence (confluence)\n - Hugging Face Spaces (huggingface)\n\nAccounts are configured interactively during publishing.\nManage/remove accounts with: quarto publish accounts",
"options": [
{
"standalone": true,
Expand Down Expand Up @@ -3596,6 +3612,10 @@
"name": "Publish with explicit credentials",
"description": "quarto publish connect --server example.com --token 01A24233E294"
},
{
"name": "Publish project to Posit Connect Cloud",
"description": "quarto publish posit-connect-cloud"
},
{
"name": "Publish without confirmation prompt",
"description": "quarto publish --no-prompt"
Expand Down Expand Up @@ -4618,6 +4638,142 @@
"equalsSign": false,
"typeDefinition": "<format>"
},
{
"global": true,
"name": "quiet",
"description": "Suppress console output.",
"args": [],
"flags": [
"--quiet"
],
"equalsSign": false,
"typeDefinition": ""
}
],
"usage": "[entry-point:string]",
"examples": [],
"commands": [
{
"name": "help",
"hidden": false,
"description": "Show this help or the help of a sub-command.",
"options": [
{
"standalone": true,
"global": true,
"prepend": true,
"name": "help",
"description": "Show this help.",
"args": [],
"flags": [
"-h",
"--help"
],
"equalsSign": false,
"typeDefinition": "",
"aliases": [
"h"
]
}
],
"usage": "[command:command]",
"examples": [],
"commands": []
}
]
},
{
"name": "typst-gather",
"hidden": false,
"description": "Gather Typst packages for a format extension.\n\nThis command scans Typst files for @preview imports and downloads the packages to a local directory for offline use.\n\nConfiguration is determined by:\n 1. typst-gather.toml in current directory (if present)\n 2. Auto-detection from _extension.yml (template and template-partials)",
"options": [
{
"standalone": true,
"global": true,
"prepend": true,
"name": "help",
"description": "Show this help.",
"args": [],
"flags": [
"-h",
"--help"
],
"equalsSign": false,
"typeDefinition": "",
"aliases": [
"h"
]
},
{
"name": "init-config",
"description": "Generate a starter typst-gather.toml in current directory",
"args": [],
"flags": [
"--init-config"
],
"equalsSign": false,
"typeDefinition": ""
},
{
"global": true,
"name": "log",
"description": "Path to log file",
"args": [
{
"optional": false,
"name": "file",
"action": "string",
"variadic": false,
"list": false,
"type": "string"
}
],
"flags": [
"--log"
],
"equalsSign": false,
"typeDefinition": "<file>"
},
{
"global": true,
"name": "log-level",
"description": "Log level (debug, info, warning, error, critical)",
"args": [
{
"optional": false,
"name": "level",
"action": "string",
"variadic": false,
"list": false,
"type": "string"
}
],
"flags": [
"--log-level"
],
"equalsSign": false,
"typeDefinition": "<level>"
},
{
"global": true,
"name": "log-format",
"description": "Log format (plain, json-stream)",
"args": [
{
"optional": false,
"name": "format",
"action": "string",
"variadic": false,
"list": false,
"type": "string"
}
],
"flags": [
"--log-format"
],
"equalsSign": false,
"typeDefinition": "<format>"
},
{
"global": true,
"name": "quiet",
Expand All @@ -4641,7 +4797,7 @@
"typeDefinition": ""
}
],
"usage": "[entry-point:string]",
"usage": "",
"examples": [],
"commands": [
{
Expand Down
6 changes: 1 addition & 5 deletions docs/cli/includes/_call-build-ts-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ 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
Expand Down Expand Up @@ -61,11 +62,6 @@ quarto call build-ts-extension [entry-point: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 Down
91 changes: 91 additions & 0 deletions docs/cli/includes/_call-typst-gather.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
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)

``` {.bash}
quarto call typst-gather
```


## Options


```{=html}
<table>
<thead>
<tr>
<th style="text-align:left;"> Flags </th>
<th style="text-align:left;"> Arguments </th>
<th style="text-align:left;"> Description </th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;"> <code>-h</code>, <code>--help</code> </td>
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Show this help. </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--init-config</code> </td>
<td style="text-align:left;"> </td>
<td style="text-align:left;"> Generate a starter typst-gather.toml in current directory </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log</code> </td>
<td style="text-align:left;"> <code><file></code> </td>
<td style="text-align:left;"> Path to log file </td>
</tr>
<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 (debug, info, warning, error, critical) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--log-format</code> </td>
<td style="text-align:left;"> <code><format></code> </td>
<td style="text-align:left;"> Log format (plain, json-stream) </td>
</tr>
<tr>
<td style="text-align:left;"> <code>--quiet</code> </td>
<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>
```



## Commands


```{=html}
<table>
<thead>
<tr>
<th style="text-align:left;"> Command </th>
<th style="text-align:left;"> Description </th>
</tr>
</thead>
<tbody>
<tr>
<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>
</tbody>
</table>
```




10 changes: 10 additions & 0 deletions docs/cli/includes/_call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ The entry point is determined by:
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
Loading