mirror of https://github.com/escalate/hugo-split-theme.git

Felix Boerner
22.16.2025 4d04c015c530c4f88fd73d29df465c2588ac35cc
docs: explain image config in detail
1 files modified
6 ■■■■ changed files
README.md 6 ●●●● patch | view | raw | blame | history
README.md
@@ -62,7 +62,7 @@
### Use an image
Set `enable` to `true`. Add your image to the `static` folder and change `file` to the location of your image accordingly. By default the image position is centered, however you can specify your own by supplying `position` with a valid CSS position.
Set `enable` to `true`. Add your image to the `static` folder and change `file` to the location of your image accordingly. By default the image position is centered, however you can specify your own by supplying `position` with a valid CSS position e.g. `center center` or `50% 0%`.
```toml
[[params.visual.image]]
@@ -81,6 +81,10 @@
# Privacy statement
```
#### Hints for image selection
The person in the image should ideally be centered. There should also be space to the right and left of the person in the image so that it fits perfectly on all screen resolutions. Optimizing the image position via CSS should be started in the mobile view. After that, the tablet and desktop views should be refined.
### Use a video
First, disable the image by setting `enable` to `false` in `[params.visual.image]`.