fix(docs): update installation instructions in Nuxt documentation

oku-ui · Dec 21, 2023 · 854e014 · 854e014
1 parent 204be95
commit 854e014
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 22 deletions.
diff --git a/.docs/content/pergel/3.nuxt/S3/1.installation.md b/.docs/content/pergel/3.nuxt/S3/1.installation.md
@@ -33,19 +33,32 @@ Node >= 20.8.0 is required.
 Nuxt >= 3.9.0 is required.
 ::
 
+2. Type Generation and `pergel/README.yaml` generation:
+
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
 
-2. Auto install dependencies:
+
+3. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
 pergel install
-pnpm nuxt prepare
 ```
 ::
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Add your server code
+4. Add your server code
 
 ::code-group
 ```ts [api/s3.post.ts]
@@ -77,7 +90,7 @@ pergelMyproject().S3().useS3()
 
 ::
 
-4. Add .env file
+5. Add .env file
 
 Root directory of your project `pergel` folder inside `README.yaml` file. Check for `projectName` and `S3` section.
 

diff --git a/.docs/content/pergel/3.nuxt/bullmq/1.installation.md b/.docs/content/pergel/3.nuxt/bullmq/1.installation.md
@@ -33,19 +33,31 @@ Node >= 20.8.0 is required.
 Nuxt >= 3.9.0 is required.
 ::
 
+2. Type Generation and `pergel/README.yaml` generation:
 
-2. Auto install dependencies:
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
+
+3. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
 pergel install
-pnpm nuxt prepare
 ```
 ::
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Prepare Type Definitions:
+4. Prepare Type Definitions:
 
 ::code-group
 ```sh [pnpm]
@@ -59,7 +71,7 @@ yarn nuxt prepare
 ```
 ::
 
-4. Add your server plugin:
+5. Add your server plugin:
 
 This code blog is a listener.
 
@@ -112,7 +124,7 @@ pergelMyproject().bullmq().nitroPlugin({})
 ::
 
 
-5. Use anywhere server side:
+6. Use anywhere server side:
 
 ::code-group
 ```ts [server/api/test.ts]
@@ -152,7 +164,7 @@ export default defineEventHandler(async () => {
 ```
 ::
 
-6. Add .env file
+7. Add .env file
 
 Root directory of your project `pergel` folder inside `README.yaml` file. Check for `projectName` and `S3` section.
 

diff --git a/.docs/content/pergel/3.nuxt/graphqlYoga/1.installation.md b/.docs/content/pergel/3.nuxt/graphqlYoga/1.installation.md
@@ -47,18 +47,31 @@ Nuxt >= 3.9.0 is required.
 ::
 
 
-2. Auto install dependencies:
+2. Type Generation and `pergel/README.yaml` generation:
+
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
+
+3. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
 pergel install
-pnpm nuxt prepare
 ```
 ::
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Add your server plugin
+4. Add your server plugin
 
 ::code-group
 ```ts [server/plugins/graphqlv1.ts]

diff --git a/.docs/content/pergel/3.nuxt/json2csv/1.installation.md b/.docs/content/pergel/3.nuxt/json2csv/1.installation.md
@@ -33,8 +33,21 @@ Node >= 20.8.0 is required.
 Nuxt >= 3.9.0 is required.
 ::
 
+2. Type Generation and `pergel/README.yaml` generation:
 
-2. Auto install dependencies:
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
+
+3. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
@@ -45,7 +58,7 @@ pnpm nuxt prepare
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Add your server code
+4. Add your server code
 
 ::code-group
 ```ts [server/api/sendemail.ts]

diff --git a/.docs/content/pergel/3.nuxt/nodeCron/1.installation.md b/.docs/content/pergel/3.nuxt/nodeCron/1.installation.md
@@ -33,19 +33,31 @@ Node >= 20.8.0 is required.
 Nuxt >= 3.9.0 is required.
 ::
 
+2. Type Generation and `pergel/README.yaml` generation:
 
-2. Auto install dependencies:
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
+
+4. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
 pergel install
-pnpm nuxt prepare
 ```
 ::
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Create 'server/plugins/pluginName.ts' file:
+5. Create 'server/plugins/pluginName.ts' file:
 
 Note: You can change the plugin name.
 

diff --git a/.docs/content/pergel/3.nuxt/ses/1.installation.md b/.docs/content/pergel/3.nuxt/ses/1.installation.md
@@ -34,18 +34,31 @@ Nuxt >= 3.9.0 is required.
 ::
 
 
-2. Auto install dependencies:
+2. Type Generation and `pergel/README.yaml` generation:
+
+::code-group
+```sh [pnpm]
+pnpm nuxt prepare
+```
+```sh [npm]
+npm run nuxt prepare
+```
+```sh [yarn]
+yarn nuxt prepare
+```
+::
+
+3. Auto install dependencies:
 
 ::code-group
 ```sh [terminal]
 pergel install
-pnpm nuxt prepare
 ```
 ::
 
 :read-more{title="Install Pergel CLI" to="/pergel/cli"}
 
-3. Add your server code
+4. Add your server code
 
 ::code-group
 ```ts [server/api/sendemail.ts]
@@ -98,7 +111,7 @@ pergelMyproject().ses().use()
 
 ::
 
-4. Add .env file
+5. Add .env file
 
 Root directory of your project `pergel` folder inside `README.yaml` file. Check for `projectName` and `ses` section.