Skip to content

Commit e171891

Browse files
author
Julien Lehuen
committed
docs: Update thumbnail documentation for latest CLI
There was a refactor where `marimo tools thumbnails generate` was replaced with `marimo export thumbnail`. The documentation still showed outdated example commands.
1 parent 2dfb689 commit e171891

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/guides/publishing/opengraph.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ __marimo__/assets/<notebook_stem>/opengraph.png
4646
To generate these thumbnails, use:
4747

4848
```bash
49-
marimo tools thumbnails generate notebook.py
50-
marimo tools thumbnails generate folder/
49+
marimo export thumbnail notebook.py
50+
marimo export thumbnail folder/
5151
```
5252

5353
For execution and sandbox options (and for Playwright installation instructions), see [Thumbnails](thumbnails.md).

docs/guides/publishing/thumbnails.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Generate screenshot-based thumbnail images for notebooks, used by [OpenGraph previews](opengraph.md) and cards in [gallery mode](../apps.md#gallery-mode).
44

55
```bash
6-
marimo export thumbnail generate notebook.py
6+
marimo export thumbnail notebook.py
77

88
## Output location
99

@@ -31,13 +31,13 @@ This is the default OpenGraph thumbnail path used by [OpenGraph previews](opengr
3131
You can generate a thumbnail for a single notebook:
3232
3333
```bash
34-
marimo tools thumbnails generate notebook.py
34+
marimo export thumbnail notebook.py
3535
```
3636

3737
Or generate thumbnails for all notebooks in a directory:
3838

3939
```bash
40-
marimo tools thumbnails generate folder/
40+
marimo export thumbnail folder/
4141
```
4242

4343
When you pass a directory, marimo scans it for marimo notebooks and skips non-notebook files (for example `README.md`).
@@ -49,19 +49,19 @@ By default, thumbnails are generated without executing the notebook (fast; no ou
4949
=== "No execution (default)"
5050

5151
```bash
52-
marimo tools thumbnails generate notebook.py
52+
marimo export thumbnail notebook.py
5353
```
5454

5555
=== "Execute notebook"
5656

5757
```bash
58-
marimo tools thumbnails generate notebook.py --execute
58+
marimo export thumbnail --execute notebook.py
5959
```
6060

6161
=== "Execute in a sandbox"
6262

6363
```bash
64-
marimo tools thumbnails generate notebook.py --execute --sandbox
64+
marimo export thumbnail --execute --sandbox notebook.py
6565
```
6666

6767
!!! note "Requires uv"
@@ -81,13 +81,13 @@ By default, thumbnails are generated without executing the notebook (fast; no ou
8181
If a thumbnail already exists, marimo will skip it by default. To replace existing thumbnails:
8282

8383
```bash
84-
marimo tools thumbnails generate notebook.py --overwrite
84+
marimo export thumbnail --overwrite notebook.py
8585
```
8686

8787
To write a thumbnail to a specific filename, use `--output` (single notebook only):
8888

8989
```bash
90-
marimo tools thumbnails generate notebook.py --output thumbnail.png
90+
marimo export thumbnail --output thumbnail.png notebook.py
9191
```
9292

9393
## Tuning quality
@@ -97,21 +97,21 @@ For OpenGraph previews, the default viewport size is 1200x630. marimo also uses
9797
To increase output resolution, increase `--scale` (max 4):
9898

9999
```bash
100-
marimo tools thumbnails generate notebook.py --scale 3
100+
marimo export thumbnail --scale 3 notebook.py
101101
```
102102

103103
If thumbnails appear blank or partially rendered, increase `--timeout-ms` to wait longer before the screenshot:
104104

105105
```bash
106-
marimo tools thumbnails generate notebook.py --timeout-ms 3000
106+
marimo export thumbnail --timeout-ms 3000 notebook.py
107107
```
108108

109109
## Passing arguments to notebooks
110110

111111
To pass CLI args through to the notebook, separate them with `--`:
112112

113113
```bash
114-
marimo tools thumbnails generate notebook.py -- --foo 123
114+
marimo export thumbnail notebook.py -- --foo 123
115115
```
116116

117117
For more on passing values to notebooks, see [Command Line Arguments](../../api/cli_args.md).

0 commit comments

Comments
 (0)