File tree 2 files changed +31
-1
lines changed
docs/tutorialkit.dev/src/content/docs/reference
packages/types/src/schemas
2 files changed +31
-1
lines changed Original file line number Diff line number Diff line change @@ -404,6 +404,36 @@ type TemplateType = "html" | "node" | "angular-cli" | "create-react-app" | "java
404
404
405
405
` ` `
406
406
407
+ # #### `meta`
408
+
409
+ Configures `<meta>` tags for Open Graph protocole and Twitter.
410
+ TutorialKit will use your logo as the default image.
411
+ <PropertyTable inherited type="MetaTagsSchema" />
412
+
413
+ The `MetaTagsSchema` type has the following shape :
414
+
415
+ ` ` ` ts
416
+ type MetaTagsSchema = {
417
+ image?: string;
418
+ description?: string;
419
+ title?: string;
420
+ }
421
+
422
+ ` ` `
423
+
424
+ Example value :
425
+ ` ` ` yaml
426
+ meta:
427
+ image: /cover.png
428
+ title: Title shown on social media and search engines
429
+ description: Description shown on social media and search engines
430
+ ` ` `
431
+
432
+ :::tip
433
+ If your logo uses the SVG format, it may not display on most social platforms.
434
+ Use a raster format instead, such as WEBP or PNG.
435
+ :: :
436
+
407
437
# #### `custom`
408
438
409
439
Assign custom fields to a chapter/part/lesson.
Original file line number Diff line number Diff line change @@ -211,7 +211,7 @@ export type EditorSchema = z.infer<typeof editorSchema>;
211
211
export type CustomSchema = z . infer < typeof customSchema > ;
212
212
213
213
export const webcontainerSchema = commandsSchema . extend ( {
214
- meta : metaTagsSchema . optional ( ) ,
214
+ meta : metaTagsSchema . optional ( ) . describe ( 'Configures `<meta>` tags for Open Graph protocole and Twitter.' ) ,
215
215
216
216
custom : customSchema . optional ( ) . describe ( 'Assign custom fields to a chapter/part/lesson in the Astro collection' ) ,
217
217
You can’t perform that action at this time.
0 commit comments