docs: minor wording & formatting tweaks (#24349)

This commit is contained in:
Joe Hawes 2023-11-18 12:24:13 -08:00 committed by GitHub
parent eb5a0b14a3
commit c2b8adbb93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 7 additions and 7 deletions

View File

@ -86,7 +86,7 @@ When running the release script, the following will happen:
- Pushing a git tag representing the newly published version to your git remote origin
::callout
As with other scripts, feel free to fine-tune the default `release` script in your `package.json` to better suit your need.
As with other scripts, feel free to fine-tune the default `release` script in your `package.json` to better suit your needs.
::
## Developing Modules
@ -137,7 +137,7 @@ export default defineNuxtModule((options, nuxt) => {
However, **we do not recommend** using this low-level function definition. Instead, to define a module, **we recommend** using the object-syntax with `meta` property to identify your module, especially when publishing to npm.
This helper makes writing Nuxt Module more straightforward by implementing many common patterns seen in modules, guaranteeing future compatibility, and improving your module author developer experience and the one of your module users.
This helper makes writing Nuxt modules more straightforward by implementing many common patterns needed by modules, guaranteeing future compatibility and improving the experience for both module authors and users.
```ts
import { defineNuxtModule } from '@nuxt/kit'

View File

@ -1,6 +1,6 @@
---
title: "<NuxtClientFallback>"
description: "Nuxt provides `<NuxtClientFallback>` component to render its content on the client if any of its children trigger an error in SSR"
description: "Nuxt provides the <NuxtClientFallback> component to render its content on the client if any of its children trigger an error in SSR"
links:
- label: Source (client)
icon: i-simple-icons-github

View File

@ -97,7 +97,7 @@ console.log(layoutCustomProps.title) // I am a custom layout
## Layout's Ref
To get the ref of a layout component, access it through `ref.value.layoutRef`
To get the ref of a layout component, access it through `ref.value.layoutRef`.
````vue [app.vue]
<script setup lang="ts">

View File

@ -1,6 +1,6 @@
---
title: '<NuxtWelcome>'
description: The `<NuxtWelcome>` component greets users in new projects made from the starter template.
description: The <NuxtWelcome> component greets users in new projects made from the starter template.
links:
- label: Source
icon: i-simple-icons-github

View File

@ -1,6 +1,6 @@
---
title: "<NuxtIsland>"
description: "Nuxt provides `<NuxtIsland>` component to render a non-interactive component without any client JS"
description: "Nuxt provides the <NuxtIsland> component to render a non-interactive component without any client JS."
links:
- label: Source
icon: i-simple-icons-github

View File

@ -36,7 +36,7 @@ const { data, pending, error, refresh } = await useFetch('https://api.nuxtjs.dev
})
```
Results in `https://api.nuxtjs.dev/mountains?param1=value1&param2=value2`
The above example results in `https://api.nuxtjs.dev/mountains?param1=value1&param2=value2`.
You can also use [interceptors](https://github.com/unjs/ofetch#%EF%B8%8F-interceptors):