Update docs

This commit is contained in:
Alan Grainger
2026-10-08 22:33:54 +13:00
parent ecc22d2a08
commit bbff86957a
14 changed files with 1196 additions and 217 deletions
+22 -21
View File
@@ -21,24 +21,6 @@ Show the gallery title and group photos by month:
}
```
## `singleImage`
**Type:** `bool` · **Default:** `false`
By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item.
## `singleVideo`
**Type:** `bool` · **Default:** `true`
When a share contains a single video, show a gallery page. Set to `false` to link directly to the video file instead.
## `singleItemAutoOpen`
**Type:** `bool` · **Default:** `true`
When a share contains a single item and is opened on its gallery page, automatically open the lightbox on the asset.
## `showTitle`
**Type:** `bool` · **Default:** `true`
@@ -69,6 +51,12 @@ Format for the [`showExpiryDate`](#showexpirydate) date, as a [dayjs format stri
Language for the [`showExpiryDate`](#showexpirydate) date when the format uses names (e.g. `MMMM` for month names), as a [dayjs locale code](https://github.com/iamkun/dayjs/tree/dev/src/locale) such as `"de"`, `"fr"` or `"en-gb"`. The default is English. The default numeric format needs no locale. The date-group headers from [`groupByDate`](#groupbydate) follow each visitor's own browser language instead.
## `showDownloadZip`
**Type:** `bool` · **Default:** `true`
Show the "download all" button in the header and the multi-select download toolbar. Only takes effect when downloads are allowed by [`allowDownload`](/config/ipp-options#allowdownload). Set to `false` to hide zip downloads while still offering single downloads in the lightbox ([`lightbox.showDownload`](/config/lightbox#showdownload)).
## `groupByDate`
**Type:** `bool` or `string` · **Default:** `false`
@@ -76,16 +64,29 @@ Language for the [`showExpiryDate`](#showexpirydate) date when the format uses n
Group the gallery's thumbnails by date, with a header above each group.
- `false` - no grouping (default).
- `"month"` - month headers like "December 2024". `true` means the same.
- `"month"` - month headers like "December 2024".
- `"day"` - day headers like "Wed, 25 Dec 2024" (matching Immich's own timeline format).
- `true` - the same as `"month"`.
Grouping uses the date each photo was taken, as in Immich's own timeline. Groups follow the album's sort order in Immich, and newest first for shares without one. Photos with no date go under an "Undated" header at the end.
## `showDownloadZip`
## `singleImage`
**Type:** `bool` · **Default:** `false`
By default a link to a single image will directly open the image file. Set to `true` if you want to show a gallery page instead for a single item.
## `singleVideo`
**Type:** `bool` · **Default:** `true`
Show the "download all" button in the header and the multi-select download toolbar. Only takes effect when downloads are allowed by [`allowDownload`](/config/ipp-options#allowdownload). Set to `false` to hide zip downloads while still offering single downloads in the lightbox ([`lightbox.showDownload`](/config/lightbox#showdownload)).
When a share contains a single video, show a gallery page. Set to `false` to link directly to the video file instead.
## `singleItemAutoOpen`
**Type:** `bool` · **Default:** `true`
When a share contains a single item and is opened on its gallery page, automatically open the lightbox on the asset.
## `cacheTime`