@jlengstorf/get-share-image
Advanced tools
Comparing version 0.0.3 to 0.1.0
{ | ||
"name": "@jlengstorf/get-share-image", | ||
"version": "0.0.3", | ||
"version": "0.1.0", | ||
"main": "index.js", | ||
@@ -5,0 +5,0 @@ "author": "Jason Lengstorf <jason@lengstorf.com> (https://lengstorf.com)", |
@@ -46,20 +46,21 @@ # Generate Social Media Images Using Cloudinary | ||
| name | required | description | | ||
| ----------------- | -------- | ----------------------------------------------------------------------------------- | | ||
| title | true | (string) title text to be placed on the card | | ||
| tagline | true | (string) tagline text to be placed on the card | | ||
| cloudName | true | (string) your Cloudinary cloud name (i.e. your username) | | ||
| imagePublicID | true | (string) the public ID of your social image template | | ||
| cloudinaryUrlBase | | (string, default `https://res.cloudinary.com`) URL used to access Cloudinary assets | | ||
| font | | (string, default `arial`) font to use for rendering title and tagline | | ||
| imageWidth | | (number, default `1280`) SEO image width (defaults to Twitter ratio) | | ||
| imageHeight | | (number, default `669`) SEO image height (defaults to Twitter ratio) | | ||
| textAreaWidth | | (number, default `760`) width of title and tagline text areas | | ||
| textLeftOffset | | (number, default `480`) distance from left edge to start text boxes | | ||
| titleBottomOffset | | (number, default `254`) distance from bottom to start title text | | ||
| taglineTopOffset | | (number, default `445`) distance from top to start tagline text | | ||
| textColor | | (string, default `000000`) hex value for text color | | ||
| titleFontSize | | (number, default `64`) font size to use for the title | | ||
| taglineFontSize | | (number, default `48`) font size to use for the tagline | | ||
| version | | (string) optional version string for caching | | ||
| name | required | description | | ||
| ----------------- | -------- | -------------------------------------------------------------------- | | ||
| title | true | (string) title text to be placed on the card | | ||
| tagline | true | (string) tagline text to be placed on the card | | ||
| cloudName | true | (string) your Cloudinary cloud name (i.e. your username) | | ||
| imagePublicID | true | (string) the public ID of your social image template | | ||
| cloudinaryUrlBase | | (string, default `https://res.cloudinary.com`) Cloudinary asset URL | | ||
| titleFont | | (string, default `arial`) font to use for rendering title | | ||
| taglineFont | | (string, default `arial`) font to use for rendering tagline | | ||
| imageWidth | | (number, default `1280`) SEO image width (defaults to Twitter ratio) | | ||
| imageHeight | | (number, default `669`) SEO image height (defaults to Twitter ratio) | | ||
| textAreaWidth | | (number, default `760`) width of title and tagline text areas | | ||
| textLeftOffset | | (number, default `480`) distance from left edge to start text boxes | | ||
| titleBottomOffset | | (number, default `254`) distance from bottom to start title text | | ||
| taglineTopOffset | | (number, default `445`) distance from top to start tagline text | | ||
| textColor | | (string, default `000000`) hex value for text color | | ||
| titleFontSize | | (number, default `64`) font size to use for the title | | ||
| taglineFontSize | | (number, default `48`) font size to use for the tagline | | ||
| version | | (string) optional version string for caching | | ||
@@ -66,0 +67,0 @@ ### Setting config options |
77
9113