Skip to content

Update the readme with a full documentation #6

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
d-oit merged 1 commit into from
Dec 26, 2024
Merged

Update the readme with a full documentation #6

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
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,41 @@ modules: ["slideshow-gallery"]
{{< slideshow-gallery >}}
```

## slideshow-gallery Shortcode Parameters

The `slideshow-gallery` shortcode supports the following parameters:

* `ratio`: Specifies the aspect ratio of the images. Default is "auto".
* `loading`: Specifies the loading behavior of the images. Default is "lazy".

These parameters can be used to customize the behavior and appearance of the slideshow gallery. For more details, refer to the `layouts/shortcodes/slideshow-gallery.html` file.

## Examples

Here are some examples of using the `slideshow-gallery` shortcode with different parameters:

* **Default usage**:
```markdown
{{< slideshow-gallery >}}
```

* **Specifying aspect ratio**:
```markdown
{{< slideshow-gallery ratio="16x9" >}}
```

* **Specifying loading behavior**:
```markdown
{{< slideshow-gallery loading="eager" >}}
```

* **Combining parameters**:
```markdown
{{< slideshow-gallery ratio="4x3" loading="lazy" >}}
```

These examples demonstrate how to use the `slideshow-gallery` shortcode with different parameters to customize the behavior and appearance of the slideshow gallery. For more details, refer to the `layouts/shortcodes/slideshow-gallery.html` file.

<!-- MARKDOWN LINKS -->
[hugo]: https://gohugo.io
[hinode_docs]: https://gethinode.com
Expand Down
Loading