From bc15a3a0753b9ffd161706e27aeff3428d7df05d Mon Sep 17 00:00:00 2001 From: Ben Balter Date: Tue, 19 Apr 2016 09:59:07 -0400 Subject: [PATCH] document how to use new properties --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index b62dd43..46dff37 100644 --- a/README.md +++ b/README.md @@ -153,3 +153,23 @@ The following options can be set for any particular page. While the default opti * `name` - If the name of the thing that the page represents is different from the page title. (i.e.: "Frank's Café" vs "Welcome to Frank's Café") * `type` - The type of things that the page represents. This must be a [Schema.org type](http://schema.org/docs/schemas.html), and will probably usually be something like [`BlogPosting`](http://schema.org/BlogPosting), [`NewsArticle`](http://schema.org/NewsArticle), [`Person`](http://schema.org/Person), [`Organization`](http://schema.org/Organization), etc. * `links` - An array of other URLs that represent the same thing that this page represents. For instance, Jane's bio page might include links to Jane's GitHub and Twitter profiles. + +### Customizing image output + +For most users, setting `image: [path-to-image]` on a per-page basis should be enough. If you need more control over how images are represented, the `image` property can also be an object, with the following options: + +* `path` - The relative path to the image. Same as `image: [path-to-image]` +* `twitter` - The relative path to a Twitter-specific image. +* `facebook` - The relative path to a Facebook-specific image. +* `height` - The height of the Facebook (`og:image`) image +* `width` - The width of the Facebook (`og:image`) image + +You can use any of the above, optional properties, like so: + +```yml +image: + twitter: /img/twitter.png + facebook: /img/facebook.png + height: 100 + width: 100 +```