mirror of https://github.com/escalate/hugo-split-theme.git
README.md
@@ -6,7 +6,6 @@  ## Installation Inside the folder of your Hugo site run: @@ -18,17 +17,14 @@ For more information read the official [setup guide](https://gohugo.io/getting-started/quick-start/) of Hugo. ## Getting started After installing the Split theme successfully it requires a just a few more steps to get your site finally running. ### The config file 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 @@ -48,7 +44,6 @@ Donec at libero id lectus porta dapibus eu in nibh. Cras id mauris sapien. Fusce viverra [luctus urna]({{< ref "long-text.md" >}}) ac rutrum. Duis semper elit eu mi facilisis eleifend. Donec semper, [ipsum in]({{< ref "commonmark.md" >}}) malesuada congue, purus sem ullamcorper massa, sit amet lacinia nibh enim sed massa. ``` #### Additional pages You can create additional pages as usual inside content directory. @@ -65,7 +60,6 @@ Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc, eu sollicitudin urna dolor sagittis lacus. Donec elit libero, sodales nec, volutpat a, suscipit non, turpis. Nullam sagittis. Suspendisse pulvinar, augue ac venenatis condimentum, sem libero volutpat nibh, nec pellentesque velit pede quis nunc. ``` ### 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. @@ -87,7 +81,6 @@ # Privacy statement ``` ### Use a video First, disable the image by setting `enable` to `false` in `[params.visual.image]`. @@ -98,7 +91,6 @@ 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. @@ -114,7 +106,6 @@ # 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. @@ -130,7 +121,6 @@ youtubeId = "dk9uNWPP7EA" ``` ##### Add Custom CSS Put custom css styles in static/css/style.css and enable this css in the config: @@ -140,12 +130,10 @@ enable = true ``` ##### Additional settings Set `mute` to `true` if you want the video to play muted and `false` if you want the sound. The video is coded to autoplay and loop. If you want to change that the code can be found in [`layouts/partials/video.html`](https://github.com/escalate/hugo-split-theme/tree/master/layouts/partials/video.html). ### Add links You can have up to 3 column lists in the links section. `heading` is the list heading text. For the text links `text` is the link text and `url` is the link url. Follow the same snippet structure to add more links to a list. If you only want 1 or 2 lists, just remove the link list snippet you don't want. @@ -173,7 +161,6 @@ url = "#" ``` ### Add metadata `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. @@ -186,23 +173,22 @@ twitterHandle = "onepagelove" ``` ### Add favicon Replace [`static/favicon.ico`](https://github.com/escalate/hugo-split-theme/tree/master/static/favicon.ico) with your favicon. If you don't want just delete `favicon.ico` and the line below. ```toml favicon = "favicon.ico" ``` ### Add copyright Set `copyright` with the text you want for your copyright. ```toml copyright = "©2024 Your Name" ``` ### Add Google Analytics Enable Google Analytics by adding your tracking id to `services.googleAnalytics`. Leave empty or remove if you don't want. @@ -213,7 +199,6 @@ ID = "UA-XXXXXXXX-1" ``` ### Nearly finished In order to see your site in action, run Hugo's built-in local server. @@ -224,12 +209,10 @@ Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser. ## Contributing Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/escalate/hugo-split-theme/issues) to let me know. Or make directly a [pull request](https://github.com/escalate/hugo-split-theme/pulls). See also the [Contributing](./CONTRIBUTING.md) notes. ## License The original template is released under the [Creative Commons Attribution 3.0 License](https://github.com/escalate/hugo-split-theme/blob/master/LICENSE.md). Please keep the original attribution link when using for your own project. If you'd like to use the template without the attribution, you can check out the license option via the template [author's website](https://onepagelove.com/split). @@ -241,7 +224,6 @@ licensed = true ``` ## Annotations - Original [Split](https://onepagelove.com/split) Template by [One Page Love](https://onepagelove.com)
