Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update link to useHead #1895

Merged
merged 1 commit into from
Feb 7, 2023
Merged

docs: update link to useHead #1895

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/4.api/2.composables/6.use-content-head.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ These parameters can be used from the [Front-Matter](/guide/writing/markdown#fro

| Key | Type | Default | Description |
| ------------------ | ------------------ | -------------------- | ----------------------------------------------------------------------------------- |
| `head` | `Object` | | A [useHead](https://v3.nuxtjs.org/guide/features/head-management) compatible object |
| `head` | `Object` | | A [useHead](https://nuxt.com/docs/getting-started/seo-meta#composable-usehead) compatible object |
| `title` | `String` | | Will be used as the default value for `head.title` |
| `head.title` | `String` | Parsed `title` | Sets the `<title>` tag |
| `description` | `String` | | Will be used as the default value for `head.description` |
Expand All @@ -23,7 +23,7 @@ These parameters can be used from the [Front-Matter](/guide/writing/markdown#fro
| `image.xxx` | `String` | | Any [`og:image:xxx` compatible](https://ogp.me/#structured) attribute |
| `head.image` | `String \| Object` | | Overrides the `<meta property="og:image">` |

At the exception of `title`, `description` and `image`, the `head` object behaves exactly the same in [Front-Matter](/guide/writing/markdown#front-matter) as it would in [`useHead({ ... })`](https://v3.nuxtjs.org/guide/features/head-management) composable.
At the exception of `title`, `description` and `image`, the `head` object behaves exactly the same in [Front-Matter](/guide/writing/markdown#front-matter) as it would in [`useHead({ ... })`](https://nuxt.com/docs/getting-started/seo-meta#composable-usehead) composable.

You can specify any value that is writeable in `yaml` format.

Expand Down