README.md in jekyll-linkpreview-0.4.1 vs README.md in jekyll-linkpreview-0.5.0

- old
+ new

@@ -32,10 +32,11 @@ See https://jekyllrb.com/docs/plugins/installation/ . ## Usage 1. Create `_cache` directory. + * This directory _must_ exist under your project root even if you've modified the [site source](https://jekyllrb.com/docs/configuration/options/). 1. Embed [linkpreview.css](assets/css/linkpreview.css) into your Website. 1. Use `{% linkpreview %}` tag. @@ -47,10 +48,12 @@ You can override the default templates used for generating previews, both in case Open Graph protocol metadata exists or does not exist for a given page. ### Template for pages where Open Graph protocol metadata exists 1. Place `linkpreview.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview.html`) + * The folder is the same one you would store files for use with `{% include fragment.html %}` tag. + Therefore, it *must* be under the [site's source](https://jekyllrb.com/docs/configuration/options/). 2. Use built-in variables to extract data which you would like to render. Available variables are: * **link_url** i.e. `{{ link_url }}` * **link_title** i.e. `{{ link_title }}` * **link_image** i.e. `{{ link_image }}` @@ -58,9 +61,11 @@ * **link_domain** i.e. `{{ link_domain }}` ### Template for pages where Open Graph protocol metadata does not exist 1. Place `linkpreview_nog.html` file inside `_includes/` folder of your Jekyll site (`_includes/linkpreview_nog.html`) + * The folder is the same one you would store files for use with `{% include fragment.html %}` tag. + Therefore, it *must* be under the [site's source](https://jekyllrb.com/docs/configuration/options/). 2. Use built-in variables to extract data which you would like to render. Available variables are: * **link_url** i.e. `{{ link_url }}` * **link_title** i.e. `{{ link_title }}` * **link_description** i.e. `{{ link_description }}`