https://github.com/d-oit/hinode-mod-image-lightbox-gallery
Hugo Hinode Module: Lightbox Gallery
https://github.com/d-oit/hinode-mod-image-lightbox-gallery
Last synced: 9 months ago
JSON representation
Hugo Hinode Module: Lightbox Gallery
- Host: GitHub
- URL: https://github.com/d-oit/hinode-mod-image-lightbox-gallery
- Owner: d-oit
- License: mit
- Created: 2024-12-12T17:41:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T16:30:54.000Z (10 months ago)
- Last Synced: 2025-04-01T17:45:50.676Z (10 months ago)
- Language: HTML
- Homepage:
- Size: 23.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hinode Module - Lightbox Gallery
A lightbox image function and gallery shortcode for Hugo compatible with Hinode
## About
Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Hinode is available as a [template][repository_template], and a [main theme][repository]. Visit the Hinode documentation site for [installation instructions][hinode_docs].
## Contributing
This module uses [semantic-release][semantic-release] to automate the release of new versions. The package uses `husky` and `commitlint` to ensure commit messages adhere to the [Conventional Commits][conventionalcommits] specification. You can run `npx git-cz` from the terminal to help prepare the commit message.
## Configuration
This module supports the following parameters (see the section `params.modules` in `config.toml`):
## gallery markdown shortcode
```markdown
{{< gallery >}}
```
### Parameters
- `imagePath`: The path to the images. Default is "submit". Define the files in the front matter .md file like this:
```yaml resources:
- src: "img/bird.jpg"
title: "Example caption 1"
params:
description: "Description for bird image
new line test
end of line
"
```
- `useExifCaption`: Whether to use EXIF captions. Default is **false**.
- `useRandomImageStack`: Whether to randomize the image stack. Default is **false**.
- `imageCssClass`: CSS class for the images. Default is "lightbox size-medium".
- `ratio`: Aspect ratio of the images. Default is **auto**.
- `loading`: Loading attribute for the images. Default is **lazy**.
- `searchclass`: CSS class for the search input. Default is **md**.
- `showGalleryImageCaption`: Whether to show the gallery image caption. Default is **true**.
- `showSearch`: Whether to show the search input. Default is **false**.
- `galleryCssClass`: CSS class for the gallery. Default is **normal-gallery**.
- `caption`: Hinode image figure for the image. Default is an empty string. Define the lightbox caption in front matter.
## Customization Styles
You can customize the gallery by modifying the CSS styles in the `image-lightbox-gallery.scss` file located in the `assets/scss` directory.
[hugo]: https://gohugo.io
[hinode_docs]: https://gethinode.com
[repository]: https://github.com/gethinode/hinode.git
[repository_template]: https://github.com/gethinode/template.git
[conventionalcommits]: https://www.conventionalcommits.org
[husky]: https://typicode.github.io/husky/
[semantic-release]: https://semantic-release.gitbook.io/