Skip to content

Commit

Permalink
update documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
SeferMirza committed Oct 19, 2023
1 parent a13105b commit 5094e80
Show file tree
Hide file tree
Showing 4 changed files with 287 additions and 285 deletions.
18 changes: 8 additions & 10 deletions build-and-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ For Windows systems use `build.bat`;

## Process

Process consists of 4 stages;
Process consists of 2 stages;

1. Lint checking using eslint
1. [Prebuild][], markdowns are preprocessed in this stage
1. Nuxt build
1. Prepare has 2 stage in itself
1. Lint checking using eslint
1. [Prebuild][], markdowns are preprocessed in this stage
1. Last stage differs between `build` & `run`
1. When building, there are two different options
1. It creates a static site for deployment
Expand All @@ -38,14 +38,12 @@ Process consists of 4 stages;

```mermaid
flowchart TB
subgraph nuxtbuild[nuxt build]
subgraph prepare[prepare]
direction LR
CB(client build) --> SB(server build)
E(eslint) --> P(prebuild)
end
E(eslint) --> P(prebuild)
P --> nuxtbuild
nuxtbuild -->|nuxt generate| SWS(static web site)
nuxtbuild -->|nuxt dev| OS(running on server)
prepare -->|nuxt generate| SWS(static web site)
prepare -->|nuxt dev| OS(running on server)
```

## `package.json` Configuration
Expand Down
62 changes: 28 additions & 34 deletions migration.md → change-history/package-upgrades.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
---
position: 103
---

# Migration

## Upgrage package
# Package upgrades for the new version of Nuxt

The upgrade sequences are as below. Different errors may occur if the order
changes.

### `log-symbols`
## `log-symbols`

#### 5.1.0
### 5.1.0

Added it because it is needed for the `log` task in `.prebuild`.

### `Node`
## `Node`

#### 20.8.0
### 20.8.0

When upgrading to this version, version 3.4.1 of nuxt gives run time errors.

Expand All @@ -35,9 +29,9 @@ not found: "ts.executeCommandLine(ts.sys, ts.noop, ts.sys.args);"".

Upgraded the nuxt version to 3.7.4 to fix it.

### `Mermaid-js`
## `Mermaid-js`

#### 10.4.0
### 10.4.0

Clean upgrade. No issues.

Expand All @@ -48,9 +42,9 @@ Clean upgrade. No issues.
}
```

### `dotenv`
## `dotenv`

#### 16.3.1
### 16.3.1

Clean upgrade. No issues.

Expand All @@ -61,9 +55,9 @@ Clean upgrade. No issues.
}
```

### `eslint-plugin-vue`
## `eslint-plugin-vue`

#### 9.17.0
### 9.17.0

Clean upgrade. No issues.

Expand All @@ -74,9 +68,9 @@ Clean upgrade. No issues.
}
```

### `sass`
## `sass`

#### 1.69.2
### 1.69.2

Clean upgrade. No issues.

Expand All @@ -87,9 +81,9 @@ Clean upgrade. No issues.
}
```

### `yaml`
## `yaml`

#### 2.3.2
### 2.3.2

Clean upgrade. No issues.

Expand All @@ -100,9 +94,9 @@ Clean upgrade. No issues.
}
```

### `webpack`
## `webpack`

#### 5.88.2
### 5.88.2

Clean upgrade. No issues.

Expand All @@ -113,9 +107,9 @@ Clean upgrade. No issues.
}
```

### `vue-tsc`
## `vue-tsc`

#### 1.8.19
### 1.8.19

Clean upgrade. No issues.

Expand All @@ -126,9 +120,9 @@ Clean upgrade. No issues.
}
```

### `typescript`
## `typescript`

#### 5.2.2
### 5.2.2

```json
"devDependencies": {
Expand Down Expand Up @@ -157,9 +151,9 @@ Please only submit bug reports when using the officially supported version.
=============
```

### `types/node`
## `types/node`

#### 20.8.4
### 20.8.4

```json
"devDependencies": {
Expand All @@ -171,9 +165,9 @@ Please only submit bug reports when using the officially supported version.
This version of type/node does not work with version 3.4.1 of nuxt. You can
downgrade the version or upgrade the version of nuxt for a solution.

### `nuxt`
## `nuxt`

#### 3.7.4
### 3.7.4

With this version, the generate process fails if the url of the links cannot be
generated. So make sure that the target page of the links exists.
Expand All @@ -183,9 +177,9 @@ to move to a final version nuxt project built with the new nuxt kit.

You can see this move by looking at [Move to new project](./setup-guide#move-to-new-project).

### `nuxt Content`
## `nuxt Content`

#### 2.5.2
### 2.5.2

[nuxt.config.ts]
```ts
Expand All @@ -196,7 +190,7 @@ content: {
}
```

#### 2.8.5
### 2.8.5

[nuxt.config.ts]
```ts
Expand Down
Loading

0 comments on commit 5094e80

Please sign in to comment.