diff --git a/README.md b/README.md index 1f542d8..fb738f0 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ This theme is pretty basic and covers all of the essentials. All you have to do - [Code highlighting](#code-highlighting) - [How to start](#how-to-start) - [How to configure](#how-to-configure) +- [How to add a cover image to your posts](#how-to-add-a-cover-image-to-your-posts) - [Add-ons](#add-ons) - [How to run your site](#how-to-run-your-site) - [How to edit the theme](#how-to-edit-the-theme) @@ -123,6 +124,15 @@ to `config.toml` file in your Hugo root directory and change params fields. In c **NOTE:** Please keep in mind that currently main menu doesn't support nesting. +## How to add a cover image to your posts + +Adding a cover image to your post is simple and there are two options when you edit your `index.md` file in `content/posts/blog-entry-xy/index.md`: + +* Use `cover: "/path/to/absolute/img.jpg"` to link an absolute image + * Resulting in `https://www.yourpage.com/path/to/absolute/img.jpg` +* Use `cover: "img.jpg"` and `useRelativeCover: true` to link the image relative to the blog post folder + * Resulting in `https://www.yourpage.com/posts/blog-entry-xy/img.jpg` + ## Add-ons - **Comments** — for adding comments to your blog posts please take a look at `layouts/partials/comments.html` https://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/comments.html. diff --git a/layouts/_default/list.html b/layouts/_default/list.html index eda29eb..c8dbbe5 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -26,8 +26,12 @@ {{ end }} - {{ with .Params.Cover }} - + {{ if .Params.Cover }} + {{ if .Params.UseRelativeCover }} + + {{ else }} + + {{ end }} {{ end }}
diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 5ab166f..12bc91d 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -21,8 +21,12 @@ {{ end }} - {{ with .Params.Cover }} - + {{ if .Params.Cover }} + {{ if .Params.UseRelativeCover }} + + {{ else }} + + {{ end }} {{ end }}