Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmasse-itix/photo-stream
Hugo theme for your photo albums, based on maxvoltar's photo-stream
https://github.com/nmasse-itix/photo-stream
hugo hugo-theme photo-stream photography self-hosted
Last synced: about 1 month ago
JSON representation
Hugo theme for your photo albums, based on maxvoltar's photo-stream
- Host: GitHub
- URL: https://github.com/nmasse-itix/photo-stream
- Owner: nmasse-itix
- License: mit
- Created: 2020-03-30T14:24:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T11:17:19.000Z (about 1 year ago)
- Last Synced: 2023-12-11T13:00:01.201Z (about 1 year ago)
- Topics: hugo, hugo-theme, photo-stream, photography, self-hosted
- Language: Shell
- Size: 1.11 MB
- Stars: 21
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Photo Stream
A theme to showcase your photo albums, powered by [Hugo](https://gohugo.io).
**A live demo is available [at hugo-photo-stream.netlify.app](https://hugo-photo-stream.netlify.app/).**
## Features
This theme is basically a port of [maxvoltar's photo-stream theme](https://github.com/maxvoltar/photo-stream).
Thanks to him for this nice creation!
This theme features:
* Lazy loading of photos (a photo is downloaded when it appears in the viewport)
* Albums containing photos
* Photos thumbnail are resized to fit 800x800
* The large version is resized to fit 2048x2048
* The background is filled with a tint matching the photo
* Keyboard shortcuts for previous / next / back to list
## Installation
From the root of your Hugo site, type the following:
```sh
git submodule add https://github.com/nmasse-itix/photo-stream.git themes/photo-stream
git submodule init
git submodule update
```
Now you can get updates of this theme in the future by updating the submodule:
```sh
git submodule update --remote themes/photo-stream
```
## Configuration
After installation, take a look at the `exampleSite` folder inside `themes/photo-stream`.
To get started, copy the `config.toml` file inside `exampleSite` to the root of your Hugo site:
```sh
cp themes/photo-stream/exampleSite/config.toml .
```
Now edit this file and add your own information. Note that some fields can be omitted.
## How to create an album
The theme provides an **archetype** named `album`.
Create a new album with the `hugo new` command.
```sh
hugo new my-album/index.md -k album
```
## How to add photos
To add photos to an album, simply copy your JPEG files in the album directory, **under content, NOT static!**
```sh
cp path/to/DCIM_*.jpeg content/my-album/
```
## How to customize an album
A minimal `index.md` looks like this:
```yaml
---
date: "2016-01-01"
title: Animals
- src: '**.jpeg'
---
```
This index file defines an album with a date, a title and instructs to add all JPEG files to the album.
But a usual `index.md` would include more customization:
```yaml
---
date: "2016-01-01"
title: Animals
sort_by: "Exif.Date"
resources:
- src: 'camel.jpeg'
params:
cover: true
- src: '**.jpeg'
- src: '**.jpg'
---
```
This index also specifies:
* To sort photos by date (specified in the EXIF metadata).
* To also include files with `.jpg` extension.
* To set `camel.jpeg` as the cover photo for the album.
## Global configuration
The Date format for the album can be set in your `config.toml`.
```toml
[params]
album_date_format = "01/2006"
```
Check the Go documentation for possible formats: [time.Format](https://golang.org/pkg/time/#Time.Format).
## Demo Website
A live demo is available [at hugo-photo-stream.netlify.app](https://hugo-photo-stream.netlify.app/) but you can have a look by yourself at the example site.
```sh
cd themes/photo-stream/exampleSite
./fetch-photos.sh
hugo serve
```
On netlify, you need to customize the **build command** and **publish directory**:
* Build command: `cd exampleSite && ./fetch-photos.sh && hugo`
* Publish directory: `exampleSite/public`
And add an environment variable to install a recent version of Hugo.
* `HUGO_VERSION=0.68.3`