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: minor wording & formatting tweaks #24349

Merged
merged 6 commits into from Nov 18, 2023
Merged
Show file tree
Hide file tree
Changes from 5 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
4 changes: 2 additions & 2 deletions docs/2.guide/3.going-further/3.modules.md
Expand Up @@ -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
Expand Down Expand Up @@ -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 Module more straightforward by implementing many common patterns seen in modules, guaranteeing future compatibility, improving the experience for both module authors and users.
danielroe marked this conversation as resolved.
Show resolved Hide resolved

```ts
import { defineNuxtModule } from '@nuxt/kit'
Expand Down
2 changes: 1 addition & 1 deletion docs/3.api/1.components/1.nuxt-client-fallback.md
@@ -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 <NuxtClientFallback> component to render its content on the client if any of its children trigger an error in SSR"
danielroe marked this conversation as resolved.
Show resolved Hide resolved
links:
- label: Source (client)
icon: i-simple-icons-github
Expand Down
2 changes: 1 addition & 1 deletion docs/3.api/1.components/3.nuxt-layout.md
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion docs/3.api/1.components/7.nuxt-welcome.md
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/3.api/1.components/8.nuxt-island.md
@@ -1,6 +1,6 @@
---
title: "<NuxtIsland>"
description: "Nuxt provides `<NuxtIsland>` component to render a non-interactive component without any client JS"
description: "Nuxt provides <NuxtIsland> component to render a non-interactive component without any client JS."
danielroe marked this conversation as resolved.
Show resolved Hide resolved
links:
- label: Source
icon: i-simple-icons-github
Expand Down
2 changes: 1 addition & 1 deletion docs/3.api/2.composables/use-fetch.md
Expand Up @@ -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):

Expand Down