Skip to content

upload: Add file previewers #21

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

Merged
sakshamarora1 merged 1 commit into from
Apr 10, 2026
Merged

upload: Add file previewers #21

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
Binary file modified docs/deposit/images/deposit-publish.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/deposit/images/gltf-preview.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/deposit/images/ipynb-preview.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/deposit/upload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,30 @@ If you need more, please contact us.

![Files upload area in the deposit form](images/deposit-upload.jpg)

### File previewers

CDS can display many file types directly in the browser on the record's landing page, without requiring a download. The following formats are supported:

| Format | Examples |
|---|---|
| Images | JPG, PNG, GIF, TIFF, WebP |
| Documents | PDF |
| Plain text and code | TXT, CSV, JSON, XML, Markdown |
| Notebooks | Jupyter (`.ipynb`) |
| 3D models | GLTF, GLB |
| Archives | ZIP, WARC, TAR |

Comment thread
sakshamarora1 marked this conversation as resolved.
Files that are not in a supported format will show a download button instead of a preview.

![Jupyter notebook previewer](images/ipynb-preview.jpg)

![3D model previewer](images/gltf-preview.jpg)


!!! tip

For 3D models, the previewer allows you to rotate, zoom, and pan the model directly in the browser. No additional software is required.

### Embargo

You can apply an embargo to one or more files by selecting **Apply an embargo** and configuring the embargo policy:
Expand Down