docs: refactor and declutter documentation (one-minute hero)
This commit is contained in:
31
README.md
31
README.md
@@ -94,40 +94,13 @@ All gallery structure — hero images, albums, subpages, grid layout, footer —
|
||||
|
||||
### Theming
|
||||
|
||||
Seven built-in presets with distinct visual identities — or mix and match with fine-grained control over colors, fonts, corners, photo frames, hero layout, and grid style.
|
||||
Six built-in presets with distinct visual identities — or mix and match with fine-grained control over colors, fonts, corners, photo frames, hero layout, and grid style.
|
||||
|
||||
```yaml
|
||||
theme: studio # or: minimal, editorial, classic, noir, monograph
|
||||
```
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><strong>Studio</strong><br><em>Leica-inspired, red dot</em></td>
|
||||
<td align="center"><strong>Minimal</strong><br><em>Swiss brutalist, fullbleed hero</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="docs/screenshots/theme-studio-home.png" width="400" alt="Studio theme" /></td>
|
||||
<td><img src="docs/screenshots/theme-minimal-home.png" width="400" alt="Minimal theme" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Editorial</strong><br><em>Cinematic magazine, warm charcoal</em></td>
|
||||
<td align="center"><strong>Classic</strong><br><em>Gilded gallery, gold accents</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="docs/screenshots/theme-editorial-home.png" width="400" alt="Editorial theme" /></td>
|
||||
<td><img src="docs/screenshots/theme-classic-home.png" width="400" alt="Classic theme" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Noir</strong><br><em>Darkroom analog, film noir</em></td>
|
||||
<td align="center"><strong>Monograph</strong><br><em>Typographic, book-like</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="docs/screenshots/theme-noir-home.png" width="400" alt="Noir theme" /></td>
|
||||
<td><img src="docs/screenshots/theme-monograph-home.png" width="400" alt="Monograph theme" /></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
→ **[Theming Guide](docs/theming.md)**
|
||||
→ **[View all Themes & Configuration Guide](docs/theming.md)**
|
||||
|
||||
## Docker
|
||||
|
||||
|
||||
@@ -6,6 +6,16 @@ All gallery structure is defined in `content/gallery.yaml`. Copy the example to
|
||||
cp content/gallery.yaml.example content/gallery.yaml
|
||||
```
|
||||
|
||||
**Contents:**
|
||||
- [Hero Images](#hero-images)
|
||||
- [Standalone Albums](#standalone-albums)
|
||||
- [Subpages & Categories](#subpages)
|
||||
- [Grid Layout](#grid-layout)
|
||||
- [EXIF on Hover](#exif-on-hover)
|
||||
- [Footer](#footer)
|
||||
- [About Page](#about-page)
|
||||
- [Finding UUIDs](#finding-uuids)
|
||||
|
||||
## Hero Images
|
||||
|
||||
Single image or crossfade carousel on the homepage:
|
||||
|
||||
@@ -25,61 +25,27 @@ That's it. Your entire gallery switches to the minimal theme.
|
||||
|
||||
Default is `studio` if no theme is specified.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><strong>Studio</strong><br><em>Leica-inspired, red dot</em></td>
|
||||
<td align="center"><strong>Minimal</strong><br><em>Swiss brutalist, fullbleed hero</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-studio-home.png" width="400" alt="Studio theme" /></td>
|
||||
<td><img src="screenshots/theme-minimal-home.png" width="400" alt="Minimal theme" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Editorial</strong><br><em>Cinematic magazine, warm charcoal</em></td>
|
||||
<td align="center"><strong>Classic</strong><br><em>Gilded gallery, gold accents</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-editorial-home.png" width="400" alt="Editorial theme" /></td>
|
||||
<td><img src="screenshots/theme-classic-home.png" width="400" alt="Classic theme" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Noir</strong><br><em>Darkroom analog, film noir</em></td>
|
||||
<td align="center"><strong>Monograph</strong><br><em>Typographic, book-like</em></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-noir-home.png" width="400" alt="Noir theme" /></td>
|
||||
<td><img src="screenshots/theme-monograph-home.png" width="400" alt="Monograph theme" /></td>
|
||||
</tr>
|
||||
</table>
|
||||
### Theme Gallery
|
||||
_From top to bottom: Studio, Minimal, Editorial, Classic, Noir, Monograph_
|
||||
|
||||
<p align="center">
|
||||
<img src="screenshots/theme-studio-home.png" width="49%" alt="Studio theme" />
|
||||
<img src="screenshots/theme-minimal-home.png" width="49%" alt="Minimal theme" />
|
||||
<img src="screenshots/theme-editorial-home.png" width="49%" alt="Editorial theme" />
|
||||
<img src="screenshots/theme-classic-home.png" width="49%" alt="Classic theme" />
|
||||
<img src="screenshots/theme-noir-home.png" width="49%" alt="Noir theme" />
|
||||
<img src="screenshots/theme-monograph-home.png" width="49%" alt="Monograph theme" />
|
||||
</p>
|
||||
|
||||
### Grid View Examples
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><strong>Studio</strong></td>
|
||||
<td align="center"><strong>Minimal</strong></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-studio-grid.png" width="400" alt="Studio grid" /></td>
|
||||
<td><img src="screenshots/theme-minimal-grid.png" width="400" alt="Minimal grid" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Editorial</strong></td>
|
||||
<td align="center"><strong>Classic</strong></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-editorial-grid.png" width="400" alt="Editorial grid" /></td>
|
||||
<td><img src="screenshots/theme-classic-grid.png" width="400" alt="Classic grid" /></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><strong>Noir</strong></td>
|
||||
<td align="center"><strong>Monograph</strong></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="screenshots/theme-noir-grid.png" width="400" alt="Noir grid" /></td>
|
||||
<td><img src="screenshots/theme-monograph-grid.png" width="400" alt="Monograph grid" /></td>
|
||||
</tr>
|
||||
</table>
|
||||
<p align="center">
|
||||
<img src="screenshots/theme-studio-grid.png" width="49%" alt="Studio grid" />
|
||||
<img src="screenshots/theme-minimal-grid.png" width="49%" alt="Minimal grid" />
|
||||
<img src="screenshots/theme-editorial-grid.png" width="49%" alt="Editorial grid" />
|
||||
<img src="screenshots/theme-classic-grid.png" width="49%" alt="Classic grid" />
|
||||
<img src="screenshots/theme-noir-grid.png" width="49%" alt="Noir grid" />
|
||||
<img src="screenshots/theme-monograph-grid.png" width="49%" alt="Monograph grid" />
|
||||
</p>
|
||||
|
||||
### What makes each theme unique
|
||||
|
||||
|
||||
Reference in New Issue
Block a user