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: format docs & update links & fix mistakes #1982

Merged
merged 9 commits into from
Apr 12, 2023
12 changes: 6 additions & 6 deletions docs/content-v1/en/1.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: 'Install @nuxt/content in only two steps in your Nuxt project.'
Add `@nuxt/content` dependency to your project:

::code-group
```bash [Yarn]
yarn add @nuxt/content@^1
```
```bash [Yarn]
yarn add @nuxt/content@^1
```

```bash [NPM]
npm install @nuxt/content@^1
```
```bash [NPM]
npm install @nuxt/content@^1
```
::

Then, add `@nuxt/content` to the `modules` section of `nuxt.config.js`:
Expand Down
2 changes: 1 addition & 1 deletion docs/content-v1/en/1.getting-started/3.writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Description property will contain the excerpt content unless defined within the

<alert type="info">

Be careful to enter <code>&lt;!--more--&gt;</code> exactly; i.e., all lowercase and with no whitespace.
Be careful to enter `<!--more-->` exactly; i.e., all lowercase and with no whitespace.

</alert>

Expand Down
24 changes: 12 additions & 12 deletions docs/content-v1/en/1.getting-started/6.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,13 @@ When adding a new plugin, make sure to install it in your dependencies:
::

::code-group
```bash [Yarn]
yarn add remark-emoji
```
```bash [Yarn]
yarn add remark-emoji
```

```bash [NPM]
npm install remark-emoji
```
```bash [NPM]
npm install remark-emoji
```
::

```js [nuxt.config.js]
Expand Down Expand Up @@ -246,13 +246,13 @@ This module handles code highlighting in markdown content using [PrismJS](https:
It automatically pushes the desired PrismJS theme in your Nuxt.js config, so if you want to use a different theme than the default one, for example [prism-themes](https://github.com/PrismJS/prism-themes):

::code-group
```bash [Yarn]
yarn add prism-themes
```
```bash [Yarn]
yarn add prism-themes
```

```bash [NPM]
npm install prism-themes
```
```bash [NPM]
npm install prism-themes
```
::

```js [nuxt.config.js]
Expand Down
3 changes: 1 addition & 2 deletions docs/content-v1/en/2.examples/1.basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: 'Live example of basic usage of Nuxt Content on CodeSandbox.'
toc: false
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-playground-l164h?hidenavigation=1&theme=dark"}
::
:sandbox{src="https://codesandbox.io/embed/nuxt-content-playground-l164h?hidenavigation=1&theme=dark"}
3 changes: 1 addition & 2 deletions docs/content-v1/en/2.examples/2.tailwindcss-typography.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: 'Live example of Nuxt Content with TailwindCSS Typography plugin on
toc: false
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-tailwindcss-typography-xq04z?hidenavigation=1&theme=dark"}
::
:sandbox{src="https://codesandbox.io/embed/nuxt-content-tailwindcss-typography-xq04z?hidenavigation=1&theme=dark"}
3 changes: 1 addition & 2 deletions docs/content-v1/en/2.examples/3.docs-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: 'Live example of Nuxt Content docs theme on CodeSandbox.'
toc: false
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-docs-theme-playground-inwxb?hidenavigation=1&theme=dark"}
::
:sandbox{src="https://codesandbox.io/embed/nuxt-content-docs-theme-playground-inwxb?hidenavigation=1&theme=dark"}
4 changes: 2 additions & 2 deletions docs/content-v1/en/3.community/2.integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,10 @@ export default {

You can integrate Nuxt Content with [Forestry](https://forestry.io) in a few steps.

<alert>
<alert type="info">

We recommend to take a look at this tutorial made by [Pascal Cauhรฉpรฉ](https://twitter.com/eQRoeil)

<br>
๐Ÿ‘‰ &nbsp;https://nuxt-content-and-forestry.netlify.app

</alert>
2 changes: 1 addition & 1 deletion docs/content-v1/fr/1.getting-started/1.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Utilisez `$content()` sur un rรฉpertoire afin de lister, filtrer et rechercher d

## Essayer sur CodeSandbox

::sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"}
:sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"}
12 changes: 6 additions & 6 deletions docs/content-v1/fr/1.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: 'Intรฉgrez @nuxt/content au sein de votre projet Nuxt en seulement
Ajoutez `@nuxt/content` en tant que dรฉpendence ร  votre projet:

::code-group
```bash [Yarn]
yarn add @nuxt/content
```
```bash [Yarn]
yarn add @nuxt/content
```

```bash [NPM]
npm install @nuxt/content
```
```bash [NPM]
npm install @nuxt/content
```
::

Ensuite, ajoutez `@nuxt/content` au sein de la section `modules` de votre fichier `nuxt.config.js`:
Expand Down
6 changes: 2 additions & 4 deletions docs/content-v1/fr/1.getting-started/3.writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,8 @@ Quantitรฉ totale de contenu au-delร  du plus diviseur.
La propriรฉtรฉ Description contiendra le contenu de l'extrait ร  moins qu'elle ne soit dรฉfinie dans les accessoires Front Matter.

::alert{type="info"}

Veillez ร  saisir exactement <code>&lt;!--more--&gt;</code>; c'est-ร -dire, tout en minuscules et sans espace.

::alert
Veillez ร  saisir exactement `<!--more-->`; c'est-ร -dire, tout en minuscules et sans espace.
::

Des exemples de variables seront injectรฉs dans le document:

Expand Down
10 changes: 1 addition & 9 deletions docs/content-v1/fr/1.getting-started/7.advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ description: Apprenez l'utilisation avancรฉe du module @nuxt/content

`$content` est accessible depuis **@nuxt/content**.

::alert

::alert{type="info"}
Notez que vous ne pouvez y accรฉder seulement **aprรจs que le module ait รฉtรฉ chargรฉ** par Nuxt. L'utilisation de `require(@nuxt/content)` devrait avoir lieu dans les hooks ou les mรฉthodes internes de Nuxt.

::

```js
Expand All @@ -31,9 +29,7 @@ export default {
### Gรฉnรฉration de Site Statique

::alert{type="info"}

Si vous utilisez Nuxt 2.13+, la commande `nuxt export` a une fonctionnalitรฉ de crawler intรฉgrรฉe, donc vous ne devriez pas avoir besoin de recourir ร  `generate.routes`.

::

Lors de l'utilisation de `nuxt generate`, vous devez spรฉcifier les routes dynamiques avec `generate.routes`, car Nuxt ne sait pas quelles seront ces routes donc il ne sera pas capable de les gรฉnรฉrer.
Expand Down Expand Up @@ -97,9 +93,7 @@ export default {
## Gรฉrer le Rechargement ร  Chaud

::alert{type="info"}

Lorsque vous dรฉveloppez, ce module appellera automatiquement l'action `nuxtServerInit` (si elle est dรฉfinie) et `$nuxt.refresh()` afin de rafraรฎchir la page actuelle.

::

Dans le cas oรน vous souhaiteriez รฉcouter cet รฉvรจnement et ajouter des instructions supplรฉmentaires, vous pouvez รฉcouter l'รฉvรจnement `content:update` cรดtรฉ client en utilisant `$nuxt.$on('content:update')`:
Expand Down Expand Up @@ -135,9 +129,7 @@ Dรจs lors que vous opรจrerez un changement sur un des fichiers au sein du rรฉper
Dans le cas d'articles, le contenu peut รชtre utilisรฉ pour gรฉnรฉrer des fils d'actualitรฉs en utilisant le module [@nuxtjs/feed](https://github.com/nuxt-community/feed-module).

::alert{type="info"}

Pour utiliser `$content` au sein de l'option `feed`, vous devez ajouter `@nuxt/content` avant `@nuxtjs/feed` dans la propriรฉtรฉ `modules`.

::

**Exemple**
Expand Down
3 changes: 1 addition & 2 deletions docs/content-v1/fr/2.examples/1.basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: "Exemple en direct d'utilisation de base de Nuxt Content sur CodeSa
toc: false
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-playground-l164h?hidenavigation=1&theme=dark"}
::
:sandbox{src="https://codesandbox.io/embed/nuxt-content-playground-l164h?hidenavigation=1&theme=dark"}
2 changes: 1 addition & 1 deletion docs/content-v1/fr/2.examples/2..tailwindcss-typography.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: 'Exemple en direct de contenu Nuxt avec le plugin TailwindCSS Typog
toc: true
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-tailwindcss-typography-twhtf?hidenavigation=1&theme=dark"}
:sandbox{src="https://codesandbox.io/embed/nuxt-content-tailwindcss-typography-twhtf?hidenavigation=1&theme=dark"}
3 changes: 1 addition & 2 deletions docs/content-v1/fr/2.examples/3.docs-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ description: 'Exemple en direct du thรจme de la documentation Nuxt Content sur C
toc: true
---

::sandbox{src="https://codesandbox.io/embed/nuxt-content-docs-theme-playground-inwxb?hidenavigation=1&theme=dark"}
::
:sandbox{src="https://codesandbox.io/embed/nuxt-content-docs-theme-playground-inwxb?hidenavigation=1&theme=dark"}
8 changes: 2 additions & 6 deletions docs/content-v1/fr/3.community/2.integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ Dans le cas d'articles, le contenu peut รชtre utilisรฉ pour gรฉnรฉrer des fils d
en utilisant le module [@nuxtjs/feed](https://github.com/nuxt-community/feed-module).

::alert{type="info"}

Pour utiliser `$content` ร  l'intรฉrieur de l'option `feed`, vous devez ajouter `@nuxt/content` avant `@nuxtjs/feed` dans la propriรฉtรฉ `modules`.

Pour utiliser `$content` ร  l'intรฉrieur de l'option `feed`, vous devez ajouter `@nuxt/content` avant `@nuxtjs/feed` dans la propriรฉtรฉ `modules`.
::

Vous pouvez accรฉder ร  votre flux via : `baseUrl + baseLinkFeedArticles + file`
Expand Down Expand Up @@ -276,10 +274,8 @@ export default {

Vous pouvez intรฉgrer Nuxt Content avec [Forestry](https://forestry.io) en quelques รฉtapes.

::alert

::alert{type="info"}
Nous vous recommandons de jeter un ล“il ร  ce tutoriel rรฉalisรฉ par [Pascal Cauhรฉpรฉ](https://twitter.com/eQRoeil)

๐Ÿ‘‰ &nbsp;https://nuxt-content-and-forestry.netlify.app

::
14 changes: 7 additions & 7 deletions docs/content-v1/ja/1.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: 'ใŸใฃใŸ2ใคใฎใ‚นใƒ†ใƒƒใƒ—ใงใ‚ใชใŸใฎNuxtใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆ
ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใซ `@nuxt/content` ใฎไพๅญ˜้–ขไฟ‚ใ‚’่ฟฝๅŠ ใ—ใพใ™ใ€‚

::code-group
```bash [Yarn]
yarn add @nuxt/content
```
```bash [NPM]
npm install @nuxt/content
```
```bash [Yarn]
yarn add @nuxt/content
```

```bash [NPM]
npm install @nuxt/content
```
::

ใใ—ใฆใ€`nuxt.config.js` ใฎ `modules` ใ‚ปใ‚ฏใ‚ทใƒงใƒณใซ `@nuxt/content` ใ‚’่ฟฝๅŠ ใ—ใพใ™ใ€‚
Expand Down
8 changes: 2 additions & 6 deletions docs/content-v1/ja/1.getting-started/3.writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,12 @@ title: Introduction

Description ใƒ—ใƒญใƒ‘ใƒ†ใ‚ฃใซใฏใ€ใƒ•ใƒญใƒณใƒˆใƒžใ‚ฟใƒผ ใƒ—ใƒญใƒƒใƒ—ๅ†…ใงๅฎš็พฉใ•ใ‚Œใฆใ„ใชใ„้™ใ‚Šใ€ๆŠœ็ฒ‹ใ‚ณใƒณใƒ†ใƒณใƒ„ใŒๅซใพใ‚Œใพใ™ใ€‚


::alert{type="info"}
<code>&lt;!--more--&gt;</code> ใ‚’ๆญฃ็ขบใซๅ…ฅๅŠ›ใ™ใ‚‹ใ‚ˆใ†ใซๆณจๆ„ใ—ใฆใใ ใ•ใ„ใ€‚ ใคใพใ‚Šใ€ใ™ในใฆๅฐๆ–‡ๅญ—ใงใ€็ฉบ็™ฝใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚
`<!--more-->` ใ‚’ๆญฃ็ขบใซๅ…ฅๅŠ›ใ™ใ‚‹ใ‚ˆใ†ใซๆณจๆ„ใ—ใฆใใ ใ•ใ„ใ€‚ ใคใพใ‚Šใ€ใ™ในใฆๅฐๆ–‡ๅญ—ใงใ€็ฉบ็™ฝใฏใ‚ใ‚Šใพใ›ใ‚“ใ€‚
::

ๅค‰ๆ•ฐใฎไพ‹ใŒใƒ‰ใ‚ญใƒฅใƒกใƒณใƒˆใซๆŒฟๅ…ฅใ•ใ‚Œใพใ™ใ€‚

```json
{
body: Object
Expand Down Expand Up @@ -321,9 +321,7 @@ multiselectOptions:
</div>

::alert{type="info"}

ใ“ใ‚Œใ‚‰ใฎใ‚ณใƒณใƒใƒผใƒใƒณใƒˆใฏ `<nuxt-content>` ใ‚ณใƒณใƒใƒผใƒใƒณใƒˆใ‚’ไฝฟใฃใฆใƒฌใƒณใƒ€ใƒชใƒณใ‚ฐใ•ใ‚Œใพใ™ใ€‚[ใ‚ณใƒณใƒ†ใƒณใƒ„ใ‚’่กจ็คบใ™ใ‚‹](/ja/displaying#component)ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„ใ€‚

::

ใพใŸMarkdownใฎไธญใง`<template>`ใ‚ฟใ‚ฐใ‚’***ไฝฟ็”จใงใใชใ„***ใ“ใจใซใ‚‚ๆณจๆ„ใ—ใฆใใ ใ•ใ„ใ€‚๏ผˆไพ‹: `v-slot`ใจไฝฟ็”จใ™ใ‚‹๏ผ‰
Expand Down Expand Up @@ -359,9 +357,7 @@ content/
> ใ“ใฎใƒšใƒผใ‚ธใฎๅณๅดใซ่กจ็คบใ•ใ‚Œใฆใ„ใ‚‹็›ฎๆฌกใ‚’ไพ‹ใซ่ฆ‹ใฆใฟใพใ—ใ‚‡ใ†ใ€‚

::alert{type="info"}

ใ‚ขใƒ—ใƒชใซ็›ฎๆฌกใ‚’ๅฎŸ่ฃ…ใ™ใ‚‹ๆ–นๆณ•ใซใคใ„ใฆใ€[ใ“ใฎๅฎŸ่ฃ…ไพ‹](/ja/examples#็›ฎๆฌก)ใ‚’ๅ‚็…งใ—ใฆใใ ใ•ใ„

::

### ็”จไพ‹
Expand Down
2 changes: 0 additions & 2 deletions docs/content-v1/ja/1.getting-started/4.fetching.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,7 @@ const [prev, next] = await this.$content('articles')
> `surround`ใ‚’ๅˆฉ็”จใ™ใ‚‹ๅ ดๅˆใ€`search`ใ€`limit`ใ€`skip`ใฏ่€ƒๆ…ฎใ•ใ‚Œใพใ›ใ‚“ใ€‚

::alert{type="info"}

ใ‚ขใƒ—ใƒชใซๅ‰ๅพŒใฎ่จ˜ไบ‹ใธใฎใƒชใƒณใ‚ฏใ‚’ๅฎŸ่ฃ…ใ™ใ‚‹ๆ–นๆณ•ใซใคใ„ใฆ[ใ“ใฎๅฎŸ่ฃ…ไพ‹](/ja/examples#ใƒšใƒผใ‚ธใƒใƒผใ‚ทใƒงใƒณ)ใ‚’ๅ‚่€ƒใซใ—ใฆใใ ใ•ใ„

::

### fetch()
Expand Down
39 changes: 16 additions & 23 deletions docs/content-v1/ja/1.getting-started/6.configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ content: {
[remark](https://github.com/remarkjs/remark)ใจ[rehype](https://github.com/rehypejs/rehype)ใ‚’ไฝฟใฃใฆใ€Markdownใƒ•ใ‚กใ‚คใƒซใ‚’JSON ASTใซใ‚ณใƒณใƒ‘ใ‚คใƒซใ—ใ€ๅค‰ๆ•ฐ`body`ใซๆ ผ็ดใ—ใพใ™ใ€‚

::alert{type="info"}

ไปฅไธ‹ใฎ่ชฌๆ˜Žใฏ`remarkPlugins`ใจ`rehypePlugins`ใฎไธกๆ–นใซๅฝ“ใฆใฏใพใ‚Šใพใ™ใ€‚

::

ใฉใฎใ‚ˆใ†ใซMarkdownใ‚’ใƒ‘ใƒผใ‚นใ™ใ‚‹ใ‹่จญๅฎšใ™ใ‚‹ใซใฏใ€ๆฌกใฎใ‚ˆใ†ใซใ—ใพใ™ใ€‚
Expand Down Expand Up @@ -163,20 +161,18 @@ export default {
}
```

::alert

::alert{type="info"}
ๆ–ฐใ—ใ„ใƒ—ใƒฉใ‚ฐใ‚คใƒณใ‚’่ฟฝๅŠ ใ™ใ‚‹ใจใใฏใ€ๅฟ…ใšdependenciesใซใ‚คใƒณใ‚นใƒˆใƒผใƒซใ—ใฆใใ ใ•ใ„

::

::code-group
```bash [Yarn]
yarn add remark-emoji
```
```bash [Yarn]
yarn add remark-emoji
```

```bash [NPM]
npm install remark-emoji
```
```bash [NPM]
npm install remark-emoji
```
::

```js [nuxt.config.js]
Expand Down Expand Up @@ -207,18 +203,14 @@ export default {

### `markdown.basePlugins`

::alert

::alert{type="info"}
้žๆŽจๅฅจใงใ™ใ€‚ไปฃใ‚ใ‚Šใซ `markdown.remarkPlugins`ใ‚’้–ขๆ•ฐใจใ—ใฆไฝฟ็”จใ—ใฆใใ ใ•ใ„ใ€‚

::

### `markdown.plugins`

::alert

::alert{type="info"}
้žๆŽจๅฅจใงใ™ใ€‚ไปฃใ‚ใ‚Šใซ `markdown. remarkPlugins`ใ‚’้…ๅˆ—ใจใ—ใฆไฝฟ็”จใ—ใฆใใ ใ•ใ„ใ€‚

::

### `markdown.prism.theme`
Expand All @@ -231,13 +223,14 @@ export default {
ใ“ใ‚Œใฏใ€Nuxt.jsใฎ่จญๅฎšใงๅธŒๆœ›ใ™ใ‚‹PrismJSใƒ†ใƒผใƒžใ‚’่‡ชๅ‹•็š„ใซใƒ—ใƒƒใ‚ทใƒฅใ—ใพใ™ใ€‚ใƒ‡ใƒ•ใ‚ฉใƒซใƒˆใฎใƒ†ใƒผใƒžใจใฏ็•ฐใชใ‚‹ใƒ†ใƒผใƒžใ‚’ไฝฟ็”จใ—ใŸใ„ๅ ดๅˆใฏใ€[prism-themes](https://github.com/PrismJS/prism-themes)ใ‹ใ‚‰้ธใ‚“ใงๅค‰ๆ›ดใ—ใพใ™ใ€‚

::code-group
```bash [Yarn]
yarn add prism-themes
```
```bash [Yarn]

yarn add prism-themes
```

```bash [NPM]
npm install prism-themes
```
```bash [NPM]
npm install prism-themes
```
::

```js [nuxt.config.js]
Expand Down