Skip to content
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

Improve overlay text & captions documentation #24

Merged
merged 1 commit into from
Feb 8, 2025
Merged

Improve overlay text & captions documentation #24

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
15 changes: 10 additions & 5 deletions docs/text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@

This is a new feature in 0.11.0.

Captions for images are created using YAML front matter, while text overlays can be achieved in two ways: either by specifying a `descriptions` array in the front matter or by including the text within a markdown image link like `![Some Description](image.jpg)`. Although UI support for these features is planned for future updates, they currently require manual setup.
Captions for images are created using YAML front matter (inside the ` ``` `), while text overlays can be achieved in two ways: either by specifying a `descriptions` array in the front matter or by including the text within a markdown image link like `![Some Description](image.jpg)`. Although UI support for these features is planned for future updates, they currently require manual setup.

Text overlays appear when hovering over an image, and captions are displayed beneath the image set. It is also possible to make the overlay show up permanently by setting `permanentOverlay: true` in the front matter.

```
````
```image-layout-b
---
caption: Image Layout B
descriptions:
- Something
- Another thing
- Sunset on the sea
- Our spot for the night
permanentOverlay: true # the default is false
---

![](captions-and-overlay.png)
![](sunset-sailing.png)
![](serene-spot.png)
```
````

![Overlaying text and captions](captions-and-overlay.png)