Skip to content

Commit 17ebcef

Browse files
authored
docs: spelling mistakes in the migration guide (#2908)
1 parent ed72d8a commit 17ebcef

29 files changed

+30
-30
lines changed

docs/content/docs/1.getting-started/3.configuration.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export default defineNuxtConfig({
1515

1616
## `build`
1717

18-
Nuxt Content read and parse all the available contents at built time. This option let you control over parsing contents.
18+
Nuxt Content read and parse all the available contents at build time. This option gives you control over parsing contents.
1919

2020
### `markdown`
2121

@@ -183,7 +183,7 @@ export default defineNuxtConfig({
183183

184184
- `highlight.langs`
185185

186-
By default, module loads couple of languages for syntax highlighter:
186+
By default, the module loads a couple of languages for syntax highlighting:
187187

188188
```ts [Default]
189189
['json', 'js', 'ts', 'html', 'css', 'vue', 'shell', 'mdc', 'md', 'yaml']
@@ -256,7 +256,7 @@ Here is the list of supported database adapters:
256256

257257
### `SQLite`
258258

259-
If you want to change default database location and move it to elsewhere you can use `sqlite` adapter to do so. This is the default value to `database` option.
259+
If you want to change the default database location and move it to elsewhere you can use `sqlite` adapter to do so. This is the default value to the `database` option.
260260

261261
```ts [nuxt.config.ts]
262262
export default defineNuxtConfig({
@@ -271,7 +271,7 @@ export default defineNuxtConfig({
271271

272272
### `D1`
273273

274-
If you plan to deploy your application to Couldflare workers, you need to use `d1` database adapter. Create `d1` binding in Cloudflare dashboard and fill the `binding` field.
274+
If you plan to deploy your application to Cloudflare workers, you need to use the `d1` database adapter. Create a `d1` binding in the Cloudflare dashboard and fill in the `binding` field.
275275

276276
```ts [nuxt.config.ts]
277277
export default defineNuxtConfig({
@@ -286,12 +286,12 @@ export default defineNuxtConfig({
286286

287287
### `Postgres`
288288

289-
If you plan to deploy your application using PostgreSql database you need to use `postgres` database adapter.
289+
If you plan to deploy your application using PostgreSQL database you need to use the `postgres` database adapter.
290290

291291
First, make sure to install the `pg` package:
292292

293293
```bash [Terminal]
294-
npx nypm i pg
294+
npx npm i pg
295295
```
296296

297297
Then, configure the `postgres` adapter in your `nuxt.config.ts`:
@@ -310,12 +310,12 @@ export default defineNuxtConfig({
310310

311311
### `LibSQL`
312312

313-
If you plan to deploy your application using LibSQL database you need to use `libsql` database adapter.
313+
If you plan to deploy your application using a LibSQL database you need to use the `libsql` database adapter.
314314

315315
First, make sure to install the `@libsql/client` package:
316316

317317
```bash [Terminal]
318-
npx nypm i @libsql/client
318+
npx npm i @libsql/client
319319
```
320320

321321
Then, configure the `libsql` adapter in your `nuxt.config.ts`:

docs/content/docs/1.getting-started/4.migration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Migration
33
description: How to migrate from v2 to v3
44
---
55

6-
Nuxt Content v3 had been rebuilt from the ground up, resulting in a new library with enhanced capabilities. While we've redesigned concepts and components in a similar way as Content v2, breaking changes are inevitable.
6+
Nuxt Content v3 has been rebuilt from the ground up, resulting in a new library with enhanced capabilities. While we've redesigned concepts and components in a similar way as Content v2, breaking changes are inevitable.
77

88
Don't worry, you don't need to modify your content files, We made sure that Content v3 handles content in the same way as Content v2.
99

@@ -40,7 +40,7 @@ Don't worry, you don't need to modify your content files, We made sure that Cont
4040

4141
## Implement Document Driven mode in v3
4242

43-
Implementing document driven mode is Content v3 is quite easy. All you need is to create a catch-all page in Nuxt and fetch contents based on route path.
43+
Implementing document driven mode in Content v3 is quite easy. All you need is to create a catch-all page in Nuxt and fetch contents based on route path.
4444

4545
```vue [pages/[...slug\\].vue]
4646
<script lang="ts" setup>
@@ -63,9 +63,9 @@ const { data: page } = await useAsyncData(route.path, () => {
6363

6464
## Converting `queryContent` to `queryCollections`
6565

66-
As we mentioned above, `queryContent` is droped in favor of new collection based `queryCollection`. There is two main difference between these two:
66+
As we mentioned above, `queryContent` is dropped in favor of new collection based `queryCollection`. There are two main differences between these two:
6767

68-
1. `queryCollection` is builting a query for SQL database.
68+
1. `queryCollection` is building a query for SQL database.
6969
2. `queryCollection` do the search only inside the specific collection. You should know the collection.
7070

7171
```ts [Find content with path]

docs/content/docs/3.files/1.markdown.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ const { data: post } = await useAsyncData(`blog-${slug}`, () => {
8686
Read more about the [`<ContentRenderer>`](/docs/components/content-renderer) component and [`Prose Components`](/docs/components/prose).
8787
::
8888

89-
## Front-matter
89+
## Frontmatter
9090

91-
Front-matter is a convention of Markdown-based CMS to provide meta-data to pages, like description or title. In Nuxt Content, the front-matter uses the YAML syntax with `key: value` pairs.
91+
Frontmatter is a convention of Markdown-based CMS to provide meta-data to pages, like description or title. In Nuxt Content, the frontmatter uses the YAML syntax with `key: value` pairs.
9292

9393
These data are available when rendering the content and can store any information that you would need.
9494

9595
### Syntax
9696

97-
You can declare a front-matter block at the top of the Markdown files in the `content/` directory with the `---` identifier.
97+
You can declare a frontmatter block at the top of the Markdown files in the `content/` directory with the `---` identifier.
9898

9999
```md [content/index.md]
100100
---
@@ -294,7 +294,7 @@ Oops! An error occurred
294294
::
295295
```
296296

297-
The `v-bind` shorthand `:` can be also be used to bind a prop to a value in the front matter.
297+
The `v-bind` shorthand `:` can be also be used to bind a prop to a value in the frontmatter.
298298

299299
```mdc
300300
---
@@ -418,7 +418,7 @@ Attributes work on:
418418

419419
## Binding Data in Markdown
420420

421-
You can bind data within your Markdown document using the `{{ $doc.variable || 'defaultValue' }}` syntax. These values can be defined in the YAML front matter at the top of the document, within each MDC component, or injected using the `data` prop of the `<ContentRenderer>` component.
421+
You can bind data within your Markdown document using the `{{ $doc.variable || 'defaultValue' }}` syntax. These values can be defined in the YAML frontmatter at the top of the document, within each MDC component, or injected using the `data` prop of the `<ContentRenderer>` component.
422422

423423
### Example 1: Define in YAML
424424

@@ -518,7 +518,7 @@ Learn how to use `@nuxt/content`.
518518
Full amount of content beyond the more divider.
519519
```
520520

521-
Description property will contain the excerpt content unless defined within the Front Matter props.
521+
Description property will contain the excerpt content unless defined within the frontmatter props.
522522

523523
If there is no `<!--more-->` divider in the text then excerpt is undefined.
524524

docs/content/docs/3.utils/1.query-collection.md docs/content/docs/4.utils/1.query-collection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Create a query builder to search in the specific collection.
4848

4949
Search for contents that have specific `path`. (`path` is an special field in `page` collections which generates based on fs path and can be use as route to render the content)
5050

51-
- Patameter:
51+
- Parameter:
5252
- - `path`: The path string to match.
5353

5454
```ts

docs/content/docs/4.components/1.slot.md docs/content/docs/5.components/1.slot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: slot
2+
title: Slot
33
description: The fastest way to inject Markdown into your Vue components.
44
---
55

File renamed without changes.
File renamed without changes.

docs/content/docs/6.advanced/2.raw-content.md docs/content/docs/7.advanced/2.raw-content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const { data } = useAsyncData('page-' + route.path, () => queryCollection('docs'
3939
</template>
4040
```
4141

42-
In case you don't want to ship raw content of a specific file you can add `rawbody: ''` to frontmatter of that file. The auto filled value of `rawbody` is acting like default value and when you define `rawbody` in the frontmater it will overwriten.
42+
In case you don't want to ship raw content of a specific file you can add `rawbody: ''` to frontmatter of that file. The auto filled value of `rawbody` is acting like default value and when you define `rawbody` in the frontmatter it will overwritten.
4343

4444
```md [content.md]
4545
---
@@ -50,5 +50,5 @@ rawbody: ''
5050
```
5151

5252
::callout
53-
It is important to fill frontmatter fields with a same type of data that defined in collection schema. In this case `rawbody` is a string, and you should consider passing empty string. Do not use `boolean` or other type of values.
53+
It is important to fill frontmatter fields with a same type of data that is defined in collection schema. In this case `rawbody` is a string, and you should consider passing empty string. Do not use `boolean` or other type of values.
5454
::

docs/content/docs/7.studio/1.setup.md docs/content/docs/8.studio/1.setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Once created, your project URL must be set to enjoy all Studio features, especia
4848
We are proposing a GitHub Pages deployment. By using it, we will handle all the requirements for you. However, if you want to use the deployment platform of your choice, please follow the simple guideline below.
4949
::
5050

51-
To enable the live preview, you just need to activate studio in the content configuration of your fv`nuxt.config.ts` file.
51+
To enable the live preview, you just need to activate studio in the content configuration of your `nuxt.config.ts` file.
5252

5353
```ts [nuxt.config.ts]
5454
export default defineNuxtConfig({

docs/content/docs/7.studio/2.github.md docs/content/docs/8.studio/2.github.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ navigation:
77
---
88

99
::tip
10-
This section explains the syncronization behaviour between Studio and GitHub. However this process is handled directly from the platform and do not require any external action. This page purpose is purely informational.
10+
This section explains the syncronization behaviour between Studio and GitHub. However this process is handled directly from the platform and does not require any external action. This page purpose is purely informational.
1111
::
1212

1313
## Overview

docs/content/docs/7.studio/3.content.md docs/content/docs/8.studio/3.content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ Each editor serves its own purpose. Some users are used to code edition, while o
2828

2929
This editor is heavily inspired by Notion, well known for its intuitive design and flexibility. Much like a standard text editor, this editor is designed to be familiar and easy to use. However, it stands out with its additional features that improve the writing experience:
3030

31-
### Front-matter
31+
### Frontmatter
3232

33-
[Front-matter](/docs/files/markdown#front-matter) is a convention of Markdown-based CMS to provide meta-data to pages, like description or title or any other data you would like to store as `key: value` pair.
33+
[Frontmatter](/docs/files/markdown#frontmatter) is a convention of Markdown-based CMS to provide meta-data to pages, like description or title or any other data you would like to store as `key: value` pair.
3434

3535
Based on the user [collection and schema](/docs/collections/collections) provided, a form is generated to edit this metadata from the editor.
3636

File renamed without changes.
File renamed without changes.

docs/content/docs/7.studio/6.debug.md docs/content/docs/8.studio/6.debug.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,5 @@ That's it! You should now be able to access Studio UI and confirm that your conf
5858
::
5959

6060
::warning
61-
Any modification of your `nuxt.config.ts` file or any changes in a Vue file require a restart of the Nuxt dev server. Once the server has restarted you can synchronized the Studio interface by calling the `Sync meta` action from command menu :shortcut{value="meta"} :shortcut{value="K"} . A refresh of the Studio app should also applies update.
61+
Any modification of your `nuxt.config.ts` file or any changes in a Vue file require a restart of the Nuxt dev server. Once the server has restarted you can synchronize the Studio interface by calling the `Sync meta` action from command menu :shortcut{value="meta"} :shortcut{value="K"} . A refresh of the Studio app should also apply the update.
6262
::

docs/content/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ seo:
2222
The git-based CMS for :br Nuxt projects.
2323

2424
#description
25-
Nuxt Content is a module for Nuxt that provides a simple way to manage content for your application. It allows developers to write their content in Markdown, YAML, or JSON files and then query and display it in their application.
25+
Nuxt Content is a module for Nuxt that provides a simple way to manage content for your application. It allows developers to write their content in Markdown, YAML, CSV or JSON files and then query and display it in their application.
2626

2727
#links{unwrap="p"}
2828
:::u-button
@@ -58,7 +58,7 @@ Nuxt Content is a module for Nuxt that provides a simple way to manage content f
5858
File-based CMS
5959

6060
#description{unwrap="p"}
61-
Write your content in Markdown, YML, CSV or JSON and query it in your components.
61+
Write your content in Markdown, YAML, CSV or JSON and query it in your components.
6262
:::
6363

6464
:::u-page-card
@@ -360,7 +360,7 @@ Define your content structure with collections and query them with schema valida
360360
variant: naked
361361
---
362362
#title{unwrap="p"}
363-
Define schema for the collection front matter
363+
Define schema for the collection frontmatter
364364
:::
365365

366366
:::u-page-card

0 commit comments

Comments
 (0)