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

Felix Boerner
05.23.2024 e1ede226f0ced4e3a1a876873fc0ebe3623d3069
docs: improve README
1 files modified
14 ■■■■ changed files
README.md 14 ●●●● patch | view | raw | blame | history
README.md
@@ -28,6 +28,7 @@
Take a look inside the [`tests`](https://github.com/escalate/hugo-split-theme/tree/master/tests) folder of this theme. You'll find some example configurations. To use one of them, copy the `hugo.toml` in the root folder of your Hugo site. Feel free to customize this theme as you like.
### Add content
#### Homepage
@@ -86,6 +87,7 @@
# Privacy statement
```
### Use a video
First, disable the image by setting `enable` to `false` in `[params.visual.image]`.
@@ -96,6 +98,7 @@
Just like with [an image](#use-an-image) you can not display a video altogether on particular pages by setting `visual.video.enable = false` in the page's FrontMatter.
##### Use your own video
Add your video to the `static` folder and change `file` to the location of your video accordingly. Make sure you delete `youtubeId` or comment it out.
@@ -111,6 +114,7 @@
  # youtubeId = "dk9uNWPP7EA"
```
##### Use a YouTube video
Get the ID of the YouTube video and add it to `youtubeId`. Make sure you delete `file` or comment it out.
@@ -126,6 +130,7 @@
  youtubeId = "dk9uNWPP7EA"
```
##### Add Custom CSS
Put custom css styles in static/css/style.css and enable this css in the config:
@@ -174,10 +179,11 @@
`author` and `description` metadata helps search engines with how to display your site in search results. `shareImage` and `twitterHandle` help improves how your content is displayed when your site is shared across social media sites.
```toml
author = "Jenny Jones"
description = "Split is a centrally-divided layout for a professional online presence with a big image or video left with alongside content."
shareImage = "images/social.jpg"
twitterHandle = "onepagelove"
[params]
  author = "Jenny Jones"
  description = "Split is a centrally-divided layout for a professional online presence with a big image or video left with alongside content."
  shareImage = "images/social.jpg"
  twitterHandle = "onepagelove"
```