Skip to content

Commit 9446ac2

Browse files
committed
update readme with twitter cards
1 parent b4bef0e commit 9446ac2

File tree

1 file changed

+70
-33
lines changed

1 file changed

+70
-33
lines changed

README.md

Lines changed: 70 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ The module offers several settings to personalize the intended behaviour:
149149

150150
In details, you can:
151151
- set the *site name* used to populate the `og:site_name` tag;
152-
- set image placeholders for categories, products and pages to use in case no image has been set for a specific item.
152+
- set image placeholders for categories, products and pages to use in case no image has been set for a specific item;
153+
- enable **Twitter** cards markup.
153154

154155
### How to use social markup
155156

@@ -162,8 +163,14 @@ query {
162163
cmsPage(id:5) {
163164
identifier
164165
socialMarkup {
165-
property
166-
content
166+
openGraph {
167+
property
168+
content
169+
}
170+
twitterCard {
171+
name
172+
content
173+
}
167174
}
168175
}
169176
}
@@ -176,36 +183,60 @@ The response payload has the following layout:
176183
"data": {
177184
"cmsPage": {
178185
"identifier": "mypage",
179-
"socialMarkup": [
180-
{
181-
"property": "og:type",
182-
"content": "website"
183-
},
184-
{
185-
"property": "og:locale",
186-
"content": "en_US"
187-
},
188-
{
189-
"property": "og:site_name",
190-
"content": "Paskel SEO Pwa"
191-
},
192-
{
193-
"property": "og:url",
194-
"content": "https://www.paskel.com/us/en/mypage"
195-
},
196-
{
197-
"property": "og:title",
198-
"content": "My Page"
199-
},
200-
{
201-
"property": "og:description",
202-
"content": "My Page meta description"
203-
},
204-
{
205-
"property": "og:image",
206-
"content": "http://local.magento.it/pub/media/seo/tmp/cmspage/social.jpeg"
207-
}
208-
]
186+
"socialMarkup": {
187+
"openGraph": [
188+
{
189+
"property": "og:type",
190+
"content": "website"
191+
},
192+
{
193+
"property": "og:locale",
194+
"content": "en_US"
195+
},
196+
{
197+
"property": "og:site_name",
198+
"content": "Paskel SEO"
199+
},
200+
{
201+
"property": "og:url",
202+
"content": "https://www.paskel.com/us/en/mypage"
203+
},
204+
{
205+
"property": "og:title",
206+
"content": "My Page"
207+
},
208+
{
209+
"property": "og:description",
210+
"content": "My Page meta description"
211+
},
212+
{
213+
"property": "og:image",
214+
"content": "http://local.magento.it/pub/media/seo/tmp/cmspage/social.jpeg"
215+
}
216+
],
217+
"twitterCard": [
218+
{
219+
"name": "twitter:card",
220+
"content": "summary_card"
221+
},
222+
{
223+
"name": "twitter:site",
224+
"content": "@paskel"
225+
},
226+
{
227+
"name": "twitter:title",
228+
"content": "My Page"
229+
},
230+
{
231+
"name": "twitter:description",
232+
"content": "My Page meta description"
233+
},
234+
{
235+
"name": "twitter:image",
236+
"content": "http://local.magento.it/pub/media/seo/tmp/cmspage/social.jpeg"
237+
}
238+
]
239+
}
209240
}
210241
}
211242
}
@@ -223,6 +254,12 @@ Use these pieces of information to build at frontend the html social share tags
223254
<meta property="og:title" content="My Page">
224255
<meta property="og:description" content="My Page meta description">
225256
<meta property="og:image" content="http://local.magento.it/pub/media/seo/tmp/cmspage/social.jpeg">
257+
...
258+
<meta name="twitter:card" content="summary_card">
259+
<meta name="twitter:site" content="@paskel">
260+
<meta name="twitter:title" content="My Page">
261+
<meta name="twitter:description" content="My Page meta description">
262+
<meta name="twitter:image" content="http://local.magento.it/pub/media/seo/tmp/cmspage/social.jpeg">
226263
</head>
227264
```
228265

0 commit comments

Comments
 (0)