Gittes-archive/svelte-meta-tags
2
0
Fork 0
mirror of https://github.com/oekazuma/svelte-meta-tags.git synced 2025-12-11 20:15:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: make robotProps documentation easy to understand

Browse Source
This commit is contained in:
Kazuma Oe 2021-09-08 01:49:33 +00:00
parent c131a8ef91
commit 886dd33b85
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -163,29 +163,30 @@ Example:
<MetaTags
robotsProps={{
nosnippet: true,
notranslate: true,
noimageindex: true,
noarchive: true,
nosnippet: true,
maxSnippet: -1,
maxImagePreview: 'none',
maxVideoPreview: -1
maxVideoPreview: -1,
notranslate: true,
noimageindex: true,
unavailableAfter: '25 Jun 2010 15:00:00 PST'
}}
/>
```
**Available properties**
| Property | Type | Description |
| ------------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `noarchive` | boolean | Do not show a [cached link](https://support.google.com/websearch/answer/1687222) in search results. |
| `nosnippet` | boolean | Do not show a text snippet or video preview in the search results for this page. |
| `max-snippet` | number | Use a maximum of [number] characters as a textual snippet for this search result. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `max-image-preview` | 'none','standard','large' | Set the maximum size of an image preview for this page in a search results. |
| `max-video-preview` | number | Use a maximum of [number] seconds as a video snippet for videos on this page in search results. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `notranslate` | boolean | Do not offer translation of this page in search results. |
| `noimageindex` | boolean | Do not index images on this page. |
| `unavailable_after` | string | Do not show this page in search results after the specified date/time. The date/time must be specified in a widely adopted format including, but not limited to RFC 822, RFC 850, and ISO 8601. |
| Property | Type | Description |
| ------------------ | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `noarchive` | boolean | Do not show a [cached link](https://support.google.com/websearch/answer/1687222) in search results. |
| `nosnippet` | boolean | Do not show a text snippet or video preview in the search results for this page. |
| `maxSnippet` | number | Use a maximum of [number] characters as a textual snippet for this search result. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `maxImagePreview` | 'none','standard','large' | Set the maximum size of an image preview for this page in a search results. |
| `maxVideoPreview` | number | Use a maximum of [number] seconds as a video snippet for videos on this page in search results. [Read more](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives) |
| `notranslate` | boolean | Do not offer translation of this page in search results. |
| `noimageindex` | boolean | Do not index images on this page. |
| `unavailableAfter` | string | Do not show this page in search results after the specified date/time. The date/time must be specified in a widely adopted format including, but not limited to RFC 822, RFC 850, and ISO 8601. |
For more reference about the `X-Robots-Tag` visit [Google Search Central - Control Crawling and Indexing](https://developers.google.com/search/reference/robots_meta_tag?hl=en-GB#directives)