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.

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

docs: improve wording in seo docs #25692

Merged
merged 3 commits into from
Feb 9, 2024
Merged
Changes from 2 commits
Commits
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
12 changes: 6 additions & 6 deletions docs/1.getting-started/5.seo-meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Shortcuts are available to make configuration easier: `charset` and `viewport`.

## `useHead`

The [`useHead`](/docs/api/composables/use-head) composable function allows you to manage your head tags in a programmatic and reactive way,
The [`useHead`](/docs/api/composables/use-head) composable function allows you to manage your head tags programmatically and reactively,
powered by [Unhead](https://unhead.unjs.io).

As with all composables, it can only be used with a components `setup` and lifecycle hooks.
Expand Down Expand Up @@ -76,9 +76,9 @@ useSeoMeta({

Nuxt provides `<Title>`, `<Base>`, `<NoScript>`, `<Style>`, `<Meta>`, `<Link>`, `<Body>`, `<Html>` and `<Head>` components so that you can interact directly with your metadata within your component's template.

Because these component names match native HTML elements, it is very important that they are capitalized in the template.
Because these component names match native HTML elements, they must be capitalized in the template.

`<Head>` and `<Body>` can accept nested meta tags (for aesthetic reasons) but this has no effect on _where_ the nested meta tags are rendered in the final HTML.
`<Head>` and `<Body>` can accept nested meta tags (for aesthetic reasons) but this does not affect _where_ the nested meta tags are rendered in the final HTML.

<!-- @case-police-ignore html -->

Expand Down Expand Up @@ -126,7 +126,7 @@ See [@unhead/schema](https://github.com/unjs/unhead/blob/main/packages/schema/sr

### Reactivity

Reactivity is supported on all properties, as computed, getters and reactive.
Reactivity is supported on all properties, such as computed, getters, and reactive.
danielroe marked this conversation as resolved.
Show resolved Hide resolved

It's recommended to use getters (`() => value`) over computed (`computed(() => value)`).

Expand Down Expand Up @@ -170,9 +170,9 @@ It's recommended to use getters (`() => value`) over computed (`computed(() => v

### Title Template

You can use the `titleTemplate` option to provide a dynamic template for customizing the title of your site. for example, by adding the name of your site to the title of every page.
You can use the `titleTemplate` option to provide a dynamic template for customizing the title of your site, for example, by adding the name of your site to the title of every page.
danielroe marked this conversation as resolved.
Show resolved Hide resolved

The `titleTemplate` can either be a string, where `%s` is replaced with the title, or a function.
The `titleTemplate` can either be a string, where `%s` is replaced with the title or a function.
danielroe marked this conversation as resolved.
Show resolved Hide resolved

If you want to use a function (for full control), then this cannot be set in your `nuxt.config`, and it is recommended instead to set it within your `app.vue` file, where it will apply to all pages on your site:

Expand Down