Skip to content

Commit 2377331

Browse files
committed
docs: update jsdoc
1 parent 59b8846 commit 2377331

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

packages/astro/src/vite-plugins/override-components.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,18 @@ export interface OverrideComponentsOptions {
5757
Dialog?: string;
5858

5959
/**
60-
* Component for overriding links in the head tag.
60+
* Component for overriding title, links and metadata in the `<head>` tag.
6161
*
62-
* It will receive TutorialKit default links within the "default-links" slot.
62+
* This component has slots that are used to pass TutorialKit's default tags:
63+
*
64+
* - `title`: The page title
65+
* - `links`: Links for the favicon, fonts and other assets
66+
* - `meta`: Metadata and Open Graph tags
6367
*
6468
* ```jsx
65-
* <slot name="default-links"></slot>
66-
* <link rel="sitemap" href="/sitemap-index.xml" />
69+
* <slot name="title" />
70+
* <slot name="links" />
71+
* <slot name="meta" />
6772
* ```
6873
*/
6974
HeadTags: string;

0 commit comments

Comments
 (0)