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: fix typo #1634

Merged
merged 5 commits into from
Oct 24, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion docs/content/3.guide/1.writing/7.document-driven.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,4 @@ definePageMeta({

## Example

Jump into the [Document Driven Example](/examples/essentials/document-driven) to see a working example.
Jump into the [Document Driven Example](/examples/essentials/document-driven) to see a working example.
4 changes: 2 additions & 2 deletions docs/content/4.api/1.components/4.content-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ The `<ContentQuery>`{lang=html} component fetches a document and gives access to
- `without`{lang=ts}: Remove a subset of fields from an array of keys.
- Type: `Array<String>`{lang=ts}
- Default: `undefined`{lang=ts}
- `where`{lang=ts}: Filter results with a where clause definition.
- `where`{lang=ts}: Filter results with a `where` clause definition.
- Type: `{ [key: string]: any }`{lang=ts}
- Default: `undefined`{lang=ts}
- `sort`: Sort results with a sort clause definition.
- `sort`{lang=ts}: Sort results with a `sort` clause definition.
- Type: `SortParams`{lang=ts}
- Default: `undefined`{lang=ts}
- `limit`{lang=ts}: Limit the amount of results.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/4.api/1.components/7.prose.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ To overwrite a prose component, create a component with the same name in your pr

::

Check out [highlight options](/api/configuration#highlight) for more about the syntax highlighting.
Check out the [highlight options](/api/configuration#highlight) for more about the syntax highlighting.

## `ProseCodeInline`

Expand Down
6 changes: 3 additions & 3 deletions docs/content/4.api/2.composables/1.query-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const articles = await queryContent('articles').where({ age: { $gt: 18 } }).find
const articles = await queryContent('articles').where({ name: { $in: ['odin', 'thor'] } }).find()
```

In order to filter in objects and array you can use nested properties style:
In order to filter in objects and an array or arrays, you can use the nested properties style:

```ts
const products = await queryContent('products').where({ 'categories': { $contains: 'top' } }).find()
Expand Down Expand Up @@ -153,7 +153,7 @@ const articles = await queryContent('articles').find()

## `findOne()`

Fetch first matched content.
Fetch the first match of content.

```ts
const firstArticle = await queryContent('articles').findOne()
Expand All @@ -168,7 +168,7 @@ const firstArticle = await queryContent('articles').findOne()
- Type: `{ before: number, after: number }`{lang=ts}
- Default: `{ before: 1, after: 1 }`{lang=ts}

Get previous and next results around the path. The path should be full path of the target content.
Get the previous and next results around the path. The path should be the full path of the target content.

You will always obtain an array of fixed length filled with the matching document or null.

Expand Down
10 changes: 5 additions & 5 deletions docs/content/4.api/3.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The watcher is a development feature and will not be included in production.

Define different sources for contents.

Contents can located in multiple places, in multiple directories or in remote git repositories.
Contents can be located in multiple places, in multiple directories, or in remote git repositories.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
Expand Down Expand Up @@ -167,7 +167,7 @@ Whether MDC syntax should be supported or not.

Control behavior of Table of Contents generation.

- `depth`{lang=ts}: Maximum heading depth to includes in the table of contents.
- `depth`{lang=ts}: Maximum heading depth to include in the table of contents.
- `searchDepth`{lang=ts}: Maximum depth of nested tags to search for heading.

### `tags`
Expand All @@ -193,7 +193,7 @@ export default defineNuxtConfig({
- Type: `Boolean | Object`{lang=ts}
- Default: `{depth: 4, exclude: [1]}`{lang=ts}

By default Content module generates anchor links for `h2`, `h3` and `h4` heading. Using this option you can control link generation.
By default, the Content module generates anchor links for `h2`, `h3` and `h4` headings. Using this option, you can control link generation.

`false`{lang=ts} will disable link generation.

Expand All @@ -204,7 +204,7 @@ By default Content module generates anchor links for `h2`, `h3` and `h4` heading
| Option | Type | Description |
| ------- | :--------: | :------------------------------------------------------- |
| depth | `number` | Sets the maximal depth for anchor link generation. |
| exclude | `number[]` | A list of which headings to exclude from link generation |
| exclude | `number[]` | A list of headings to exclude from link generation. |


## `highlight`
Expand Down Expand Up @@ -252,7 +252,7 @@ export default defineNuxtConfig({

By default, module preloads couple of languages for syntax highlighter: `['diff', 'json', 'js', 'ts', 'css', 'shell', 'html', 'md', 'yaml']`{lang=ts}

If you plan to use code samples of other languages you need to define the language in this options.
If you plan to use code samples of other languages, you need to define the language in these options.

```ts
export default defineNuxtConfig({
Expand Down
8 changes: 4 additions & 4 deletions docs/content/4.api/4.advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ Internally, the module has specific transformers for each content type to parse
You can create custom transformers to support new content types or improve functionalities of supported content types.

1. Create your transformer. A transformer consists of 4 parts:
- `name`: Transformer name
- `extensions`: List of valid file extensions
- `parse`: If provided this function will be used to parsed the raw content
- `transform`: Received that parsed content and manipulate the content.
- `name`: Transformer name.
- `extensions`: List of valid file extensions.
- `parse`: If provided, this function will be used to parse the raw content.
- `transform`: Receives that parsed content and manipulates it.

```ts [my-transformer.ts]
// filename: my-transformer.ts
Expand Down