Skip to content

Commit

Permalink
refactor(readme): add WebSite to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
talo242 committed Aug 31, 2024
1 parent 0193a4d commit d3411db
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ If you are using **`pages`** directory then `NextSeo` is **exactly what you need
- [Organization](#organization)
- [Brand](#brand)
- [WebPage](#webpage)
- [WebSite](#website)
- [Image Metadata](#image-metadata)
- [Contributors](#contributors)

Expand Down Expand Up @@ -3474,6 +3475,48 @@ export default () => (

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

### WebSite

```jsx
import React from 'react';
import { WebSiteJsonLd } from 'next-seo';

export default () => (
<>
<h1>WebSite</h1>
<WebSiteJsonLd
name="Example"
alternateName={['Example Org', 'Example Organization']}
url="https://example.org"
publisher={{
id: 'https://example.org/#organization',
}}
/>
</>
);
```

**Data required properties**

| Property | Info |
| -------- | --------------- |
| `name` | 'The site name' |

**Data Recommended properties**

| Property | Info |
| --------------- | -------------------------------------------------------- |
| `url` | The URL of the website |
| `alternateName` | One or multiple alternate names for the site |
| `publisher` | |
| `publisher.id` | Id of the Person or Organization that published the site |

**Other**
| `useAppDir` | This should be set to true if using the new app directory. Not required if outside of the app
directory. |

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

### Image Metadata

```jsx
Expand Down

0 comments on commit d3411db

Please sign in to comment.