Skip to content

Commit d3411db

Browse files
committed
refactor(readme): add WebSite to documentation
1 parent 0193a4d commit d3411db

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

+43
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ If you are using **`pages`** directory then `NextSeo` is **exactly what you need
111111
- [Organization](#organization)
112112
- [Brand](#brand)
113113
- [WebPage](#webpage)
114+
- [WebSite](#website)
114115
- [Image Metadata](#image-metadata)
115116
- [Contributors](#contributors)
116117

@@ -3474,6 +3475,48 @@ export default () => (
34743475

34753476
For reference and more info check [Docs](https://schema.org/WebPage)
34763477

3478+
### WebSite
3479+
3480+
```jsx
3481+
import React from 'react';
3482+
import { WebSiteJsonLd } from 'next-seo';
3483+
3484+
export default () => (
3485+
<>
3486+
<h1>WebSite</h1>
3487+
<WebSiteJsonLd
3488+
name="Example"
3489+
alternateName={['Example Org', 'Example Organization']}
3490+
url="https://example.org"
3491+
publisher={{
3492+
id: 'https://example.org/#organization',
3493+
}}
3494+
/>
3495+
</>
3496+
);
3497+
```
3498+
3499+
**Data required properties**
3500+
3501+
| Property | Info |
3502+
| -------- | --------------- |
3503+
| `name` | 'The site name' |
3504+
3505+
**Data Recommended properties**
3506+
3507+
| Property | Info |
3508+
| --------------- | -------------------------------------------------------- |
3509+
| `url` | The URL of the website |
3510+
| `alternateName` | One or multiple alternate names for the site |
3511+
| `publisher` | |
3512+
| `publisher.id` | Id of the Person or Organization that published the site |
3513+
3514+
**Other**
3515+
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app
3516+
directory. |
3517+
3518+
For reference and more info check [Docs](https://schema.org/WebSite)
3519+
34773520
### Image Metadata
34783521

34793522
```jsx

0 commit comments

Comments
 (0)