Skip to content

Commit 1699bb7

Browse files
authored
Update docs for chromium deprecation in v1.9
Reflect changes from quarto-dev/quarto-cli#14335 (v1.9 backport): chromium is deprecated, chrome-headless-shell is the recommended tool, and arm64 Linux is now supported. - Upgrade diagrams.qmd Legacy Chromium callout from note to warning, add migration steps and note future removal - Update sample quarto check and quarto list tools output across bug-reports, troubleshooting, and pdf-engine pages to v1.9.37 - Fix malformed path line in troubleshooting quarto check sample - Regenerate CLI reference includes from v1.9.37 cli-info.json - Add path-scoped CLAUDE.md for auto-generated CLI includes - Exclude CLAUDE.md from preview workflow changed-files detection
1 parent bace72c commit 1699bb7

File tree

9 files changed

+67
-36
lines changed

9 files changed

+67
-36
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# quarto-web Workflow
2+
3+
## Stable → Prerelease
4+
5+
1. PRs target `main` (stable/released docs)
6+
2. On merge, `port-to-prerelease.yml` (korthout/backport-action) auto-creates a cherry-pick PR to `prerelease`
7+
3. Prerelease-specific changes (e.g., v1.10 features) are layered in a follow-up PR after the backport merges
8+
9+
Always PR to `main` first for shared content. Never PR directly to `prerelease` for changes that apply to both stable and prerelease.
10+

.github/workflows/preview.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ jobs:
155155
docs/reference/**/*.json
156156
docs/cli/*.json
157157
docs/**/images/*.png
158+
files_ignore: |
159+
**/CLAUDE.md
158160
json: true
159161
escape_json: false
160162

bug-reports.qmd

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -100,44 +100,45 @@ For instance, the markdown code you would provide might look like this:
100100

101101
````md
102102
```bash
103-
Quarto 1.5.42
103+
Quarto 1.9.37
104104
[✓] Checking versions of quarto binary dependencies...
105-
Pandoc version 3.2.0: OK
105+
Pandoc version 3.4.0: OK
106106
Dart Sass version 1.70.0: OK
107-
Deno version 1.41.0: OK
107+
Deno version 1.46.3: OK
108108
Typst version 0.11.0: OK
109109
[✓] Checking versions of quarto dependencies......OK
110110
[✓] Checking Quarto installation......OK
111-
Version: 1.5.42
111+
Version: 1.9.37
112112
Path: /Applications/quarto/bin
113113

114114
[✓] Checking tools....................OK
115-
TinyTeX: v2024.03.13
115+
TinyTeX: v2026.04
116116
Chromium: (not installed)
117+
Chrome Headless Shell: (not installed)
117118

118119
[✓] Checking LaTeX....................OK
119120
Using: TinyTex
120121
Path: /Users/username/Library/TinyTeX/bin/universal-darwin
121-
Version: 2024
122+
Version: 2026
122123

123124
[✓] Checking basic markdown render....OK
124125

125126
[✓] Checking Python 3 installation....OK
126127
Version: 3.12.1
127128
Path: /.venv/bin/python3
128129
Jupyter: 5.7.2
129-
Kernels: julia-1.10, python3
130+
Kernels: python3
130131

131132
[✓] Checking Jupyter engine render....OK
132133

133134
[✓] Checking R installation...........OK
134-
Version: 4.3.3
135-
Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources
135+
Version: 4.4.2
136+
Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources
136137
LibPaths:
137-
- /Users/username/Library/R/arm64/4.3/library
138-
- /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
139-
knitr: 1.45
140-
rmarkdown: 2.26
138+
- /Users/username/Library/R/arm64/4.4/library
139+
- /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library
140+
knitr: 1.49
141+
rmarkdown: 2.29
141142

142143
[✓] Checking Knitr engine render......OK
143144
```

docs/authoring/diagrams.qmd

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,15 @@ quarto install chrome-headless-shell
246246

247247
[Chrome Headless Shell](https://developer.chrome.com/blog/chrome-headless-shell) is a lightweight, headless-only browser from Google's [Chrome for Testing](https://developer.chrome.com/blog/chrome-for-testing) infrastructure. It has fewer system dependencies than full Chromium, making it a good fit for Docker containers and WSL environments.
248248

249-
::: callout-note
250-
## Legacy Chromium
249+
::: callout-warning
250+
## Chromium (Deprecated)
251+
252+
The `quarto install chromium` command is deprecated as of Quarto 1.9 and will be removed in a future release. It still works but displays a deprecation warning. To migrate to Chrome Headless Shell, run:
253+
254+
``` {.bash filename="Terminal"}
255+
quarto uninstall chromium
256+
quarto install chrome-headless-shell
257+
```
251258

252-
The older `quarto install chromium` command (which installs Chromium via Puppeteer) is still available but no longer recommended. If you use it, note that the Puppeteer-bundled Chromium may not work in Docker or WSL — see [Puppeteer troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker) for details.
259+
The Puppeteer-bundled Chromium installed by the old command may not work in Docker or WSL — see [Puppeteer troubleshooting](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker) for details. Chrome Headless Shell does not have these limitations and also supports arm64 Linux.
253260
:::

docs/cli/cli-info.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.9.36",
2+
"version": "1.9.37",
33
"commands": [
44
{
55
"name": "render",
@@ -361,7 +361,7 @@
361361
{
362362
"name": "preview",
363363
"hidden": false,
364-
"description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to \u001b[1mquarto render\u001b[22m.",
364+
"description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to quarto render.",
365365
"options": [
366366
{
367367
"standalone": true,

docs/cli/includes/CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CLI Reference: Auto-Generated Files
2+
3+
Files in this directory are auto-generated. Do not edit manually.
4+
5+
## Regeneration
6+
7+
1. `quarto dev-call cli-info > docs/cli/cli-info.json`
8+
2. `Rscript --vanilla _tools/reference-cli-generate-md.R`
9+
10+
Descriptions come from quarto-cli source. To change them permanently, update the CLI command definitions in quarto-cli.

docs/output-formats/pdf-engine.qmd

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,11 @@ which will provide a list of available tools, the installed versions, and the la
4444
``` bash
4545
[✓] Inspecting tools
4646

47-
Tool Status Installed Latest
48-
chromium Not installed --- 869685
49-
tinytex Up to date v2022.10 v2022.10
47+
Tool Status Installed Latest
48+
chrome-headless-shell Not installed --- 147.0.7727.56
49+
chromium Not installed --- 869685
50+
tinytex Up to date v2026.04 v2026.04
51+
verapdf Not installed --- 1.28.2
5052
```
5153

5254
To update to the latest version, use the command:

docs/projects/binder.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The following files may be generated by the `quarto use binder` command. Note th
116116

117117
`postBuild`
118118

119-
: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTex or Chromium, and to configure VSCode and the Quarto extension for VSCode when applicable.
119+
: The post build script runs code after restoring the environment. This script is generated with commands required to ensure the proper version of Quarto is present in the environment, install any required tools like TinyTeX or Chrome Headless Shell, and to configure VSCode and the Quarto extension for VSCode when applicable.
120120

121121
`apt.txt`
122122

docs/troubleshooting/index.qmd

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,46 +13,45 @@ but this page might help you get up and running quickly.
1313
You can check the version of Quarto and its dependencies by running `quarto check`. Here's an example of the output it generates:
1414

1515
```
16-
Quarto 1.6.30
17-
[✓] Checking environment information...
18-
Quarto cache location: /Users/cscheid/Library/Caches/quarto
16+
Quarto 1.9.37
1917
[✓] Checking versions of quarto binary dependencies...
2018
Pandoc version 3.4.0: OK
2119
Dart Sass version 1.70.0: OK
2220
Deno version 1.46.3: OK
2321
Typst version 0.11.0: OK
2422
[✓] Checking versions of quarto dependencies......OK
2523
[✓] Checking Quarto installation......OK
26-
Version: 1.6.30
27-
Path: /Users/cscheid/repos/github/cscheid/quarto-regress/releases/v1.6.30/binQuarto 1.5.42
24+
Version: 1.9.37
25+
Path: /Applications/quarto/bin
2826
2927
[✓] Checking tools....................OK
30-
TinyTeX: v2024.03.13
28+
TinyTeX: v2026.04
3129
Chromium: (not installed)
30+
Chrome Headless Shell: (not installed)
3231
3332
[✓] Checking LaTeX....................OK
3433
Using: TinyTex
3534
Path: /Users/username/Library/TinyTeX/bin/universal-darwin
36-
Version: 2024
35+
Version: 2026
3736
3837
[✓] Checking basic markdown render....OK
3938
4039
[✓] Checking Python 3 installation....OK
4140
Version: 3.12.1
4241
Path: /.venv/bin/python3
4342
Jupyter: 5.7.2
44-
Kernels: julia-1.10, python3
43+
Kernels: python3
4544
4645
[✓] Checking Jupyter engine render....OK
4746
4847
[✓] Checking R installation...........OK
49-
Version: 4.3.3
50-
Path: /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources
48+
Version: 4.4.2
49+
Path: /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources
5150
LibPaths:
52-
- /Users/username/Library/R/arm64/4.3/library
53-
- /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
54-
knitr: 1.45
55-
rmarkdown: 2.26
51+
- /Users/username/Library/R/arm64/4.4/library
52+
- /Library/Frameworks/R.framework/Versions/4.4-arm64/Resources/library
53+
knitr: 1.49
54+
rmarkdown: 2.29
5655
5756
[✓] Checking Knitr engine render......OK
5857
```

0 commit comments

Comments
 (0)