diff --git a/extensions/amp-pinterest/amp-pinterest.md b/extensions/amp-pinterest/amp-pinterest.md index bf73577bf66f..64d613203c6a 100644 --- a/extensions/amp-pinterest/amp-pinterest.md +++ b/extensions/amp-pinterest/amp-pinterest.md @@ -14,92 +14,94 @@ See the License for the specific language governing permissions and limitations under the License. --> -### `amp-pinterest` +## `amp-pinterest` Displays a Pinterest widget or Pin It button. ### Examples: Pin It button: `data-do="buttonPin"` - - - +``` + + +``` Embedded pin widget: `data-do="embedPin"` +``` + + +``` - - - -## Pin It Button +### Pin It Button **data-url** -Required when `data-do` is `buttonPin`. Contains the fully-qualified URL intended to be pinned or re-made into a widget. +Required when `data-do` is `buttonPin`. Contains the fully-qualified URL intended to be pinned or re-made into a widget. **data-media** -Required when `data-do` is `buttonPin`. Contains the fully-qualified URL of the image intended to be pinned. If the pin will eventually contain multimedia (such as YouTube), should point to a high-resolution thumbnail. +Required when `data-do` is `buttonPin`. Contains the fully-qualified URL of the image intended to be pinned. If the pin will eventually contain multimedia (such as a YouTube video), it should point to a high-resolution thumbnail. **data-description** -Required when `data-do` is `buttonPin`. Contains the default description that appears in the pin create form; please choose carefully, since many Pinners will close the form without pinning if it doesn't make sense. +Required when `data-do` is `buttonPin`. Contains the default description that appears in the pin create form. Please write carefully, as many Pinners will close the form without pinning if the description doesn't make sense. -### Sizing the Pin It Button +#### Sizing the Pin It Button Default small rectangular button: - height=20 width=40 + `height=20 width=40` -Small rectangular button with pin count to the right, using `data-count="beside"` +Small rectangular button with pin count to the right, using `data-count="beside"`: - height=28 width=85 + `height=28 width=85` -Small rectangular button with pin count on top, using `data-count="above"` +Small rectangular button with pin count on top, using `data-count="above"`: - height=50 width=40 + `height=50 width=40` -Large rectangular button using data-height="tall" +Large rectangular button using data-height="tall": - height=28 width=56 + `height=28 width=56` -Large rectangular button with pin count to the right, using `data-tall="true"` and `data-count="beside"` +Large rectangular button with pin count to the right, using `data-tall="true"` and `data-count="beside"`: - height=28 width=107 + `height=28 width=107` -Large rectangular button with pin count on top, using `data-height="tall"` and `data-count="above"` +Large rectangular button with pin count on top, using `data-height="tall"` and `data-count="above"`: - height=66 width=56 + `height=66 width=56` -Small circular button using `data-round="true"` +Small circular button using `data-round="true"`: - height=16 width=16 + `height=16 width=16` -Large circular button using `data-round="true"` and `data-height="tall"` +Large circular button using `data-round="true"` and `data-height="tall"`: - height=32 width=32 + `height=32 width=32` -## Follow Button +### Follow Button **data-href** -Required when `data-do` is `buttonFollow`. Contains the fully qualified Pinterest user profile url to follow. +Required when `data-do` is `buttonFollow`. Contains the fully qualified Pinterest user profile URL to follow. **data-label** -Required when `data-do` is `buttonFollow`. Contains the text to display on the follow button. +Required when `data-do` is `buttonFollow`. Contains the text to display on the follow button. -## Embedded Pin Widget +### Embedded Pin Widget **data-url** When building the Embedded Pin widget, `data-url` is required and must contain the fully-qualified URL of the Pinterest resource to be shown as a widget. - - data-do="embedPin" - data-url="https://www.pinterest.com/pin/99360735500167749/" - +``` + data-do="embedPin" + data-url="https://www.pinterest.com/pin/99360735500167749/" +```