Skip to content

Commit 3774671

Browse files
committed
update docs to note ability to pass image as a hash
1 parent 847c045 commit 3774671

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ The plugin will use the following post metadata, automatically generated by Jeky
5656

5757
Additionally, the plugin will use the following values, if present in a post's YAML front matter:
5858

59+
* `image` - URL of an image that is representative of the post (can also be passed as `image.path`)
60+
5961
* `author` - The author of the post, e.g., "Dr. Jekyll". If none is given, feed readers will look to the feed author as defined in `_config.yml`. Like the feed author, this can also be an object or a reference to an author in `_data/authors.yml` (see below).
6062

6163
### Author information
@@ -112,8 +114,6 @@ There are several ways to convey author-specific information. Author information
112114
author: benbalter
113115
```
114116

115-
* `image` - URL of an image that is representative of the post.
116-
117117
### Meta tags
118118

119119
The plugin exposes a helper tag to expose the appropriate meta tags to support automated discovery of your feed. Simply place `{% feed_meta %}` someplace in your template's `<head>` section, to output the necessary metadata.

0 commit comments

Comments
 (0)