Skip to content

Commit

Permalink
docs(docs): break into tabs
Browse files Browse the repository at this point in the history
  • Loading branch information
te6-in committed Oct 24, 2024
1 parent 616f92a commit 1c16cb9
Showing 1 changed file with 34 additions and 95 deletions.
129 changes: 34 additions & 95 deletions docs/content/docs/react/foundation/iconography/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,45 @@ description: 리뉴얼된 아이콘으로 업그레이드하는 방법을 안내

import { Accordions, Accordion } from "fumadocs-ui/components/accordion";

## 개요
## 아이콘 패키지

### 아이콘 패키지

#### 이전
### 이전

- [`@seed-deesign/react-icon`](https://www.npmjs.com/package/@seed-design/react-icon)
- [`@seed-design/vue2-icon`](https://www.npmjs.com/package/@seed-design/vue2-icon)
- [`@seed-design/vue3-icon`](https://www.npmjs.com/package/@seed-design/vue3-icon)
- deprecated: [`@seed-design/icon`](https://www.npmjs.com/package/@seed-design/icon)

#### 리뉴얼
### 리뉴얼

- [`@daangn/react-icon`](https://github.com/daangn/seed-icon-v3/pkgs/npm/react-icon)
- [`@daangn/vue2-icon`](https://github.com/daangn/seed-icon-v3/pkgs/npm/vue2-icon)
- [`@daangn/vue3-icon`](https://github.com/daangn/seed-icon-v3/pkgs/npm/vue3-icon)

### 업그레이드 방법

- [Codemod 스크립트](#codemod-스크립트)
- [수동 업그레이드](#수동-업그레이드)
## 업그레이드 방법

## Codemod 스크립트
### Codemod 스크립트

아래 두 아이콘 패키지를 사용하고 있다면, 제공되는 codemod 스크립트를 사용해서 리뉴얼된 아이콘 패키지로 손쉽게 업그레이드할 수 있습니다.

- [`@seed-deesign/react-icon`](https://www.npmjs.com/package/@seed-design/react-icon)
- deprecated: [`@seed-design/icon`](https://www.npmjs.com/package/@seed-design/icon)

### 수동 업그레이드

다음과 같은 경우에는 수동으로 업그레이드해야 합니다.

- PNG, SVG 등의 파일로 기존 아이콘을 사용하는 경우
- 다음 패키지를 사용하는 경우
- [`@seed-design/vue2-icon`](https://www.npmjs.com/package/@seed-design/vue2-icon)
- [`@seed-design/vue3-icon`](https://www.npmjs.com/package/@seed-design/vue3-icon)

<Tabs items={["codemod 스크립트", "수동 업그레이드"]}>

<Tab value="codemod 스크립트">

## Codemod 스크립트

### 결과 미리보기

#### 스크립트 실행 전
Expand Down Expand Up @@ -95,27 +105,15 @@ function App() {

[`@daangn/react-icon`](https://github.com/daangn/seed-icon-v3/pkgs/npm/react-icon)을 설치합니다.

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm install @daangn/react-icon
```

```shell tab="pnpm"
pnpm add @daangn/react-icon
```

```shell tab="yarn"
yarn add @daangn/react-icon
```

</Tabs>

</Step>

<Step>

### Codemod 스크립트 실행 후 포맷팅
### Codemod 스크립트 실행

경로 내의 코드를 일괄적으로 변환하는 codemod 스크립트를 실행합니다.

Expand Down Expand Up @@ -202,22 +200,10 @@ Time elapsed: 49.376seconds

이전 아이콘이 모두 대체된 경우, 이전 패키지를 제거할 수 있습니다.

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm uninstall @seed-design/icon @seed-design/react-icon
```

```shell tab="pnpm"
pnpm remove @seed-design/icon @seed-design/react-icon
```

```shell tab="yarn"
yarn remove @seed-design/icon @seed-design/react-icon
```

</Tabs>

</Step>

<Step>
Expand All @@ -230,14 +216,11 @@ yarn remove @seed-design/icon @seed-design/react-icon

</Steps>

## 수동 업그레이드
</Tab>

다음과 같은 경우에는 수동으로 업그레이드해야 합니다.
<Tab value="수동 업그레이드">

- PNG, SVG 등의 파일로 기존 아이콘을 사용하는 경우
- 다음 패키지를 사용하는 경우
- [`@seed-design/vue2-icon`](https://www.npmjs.com/package/@seed-design/vue2-icon)
- [`@seed-design/vue3-icon`](https://www.npmjs.com/package/@seed-design/vue3-icon)
## 수동 업그레이드

<Callout type="warn" title="시작하기 전">

Expand All @@ -256,22 +239,10 @@ yarn remove @seed-design/icon @seed-design/react-icon
- [`@seed-design/vue2-icon`](https://www.npmjs.com/package/@seed-design/vue2-icon)
- [`@seed-design/vue3-icon`](https://www.npmjs.com/package/@seed-design/vue3-icon)

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm uninstall @seed-design/vue2-icon @seed-design/vue3-icon
```

```shell tab="pnpm"
pnpm remove @seed-design/vue2-icon @seed-design/vue3-icon
```

```shell tab="yarn"
yarn remove @seed-design/vue2-icon @seed-design/vue3-icon
```

</Tabs>

</Step>

<Step>
Expand All @@ -280,58 +251,22 @@ yarn remove @seed-design/vue2-icon @seed-design/vue3-icon

#### React

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm install @daangn/react-icon
```

```shell tab="pnpm"
pnpm add @daangn/react-icon
```

```shell tab="yarn"
yarn add @daangn/react-icon
```

</Tabs>

#### Vue 2

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm install @daangn/vue2-icon
```

```shell tab="pnpm"
pnpm add @daangn/vue2-icon
```

```shell tab="yarn"
yarn add @daangn/vue2-icon
```

</Tabs>

#### Vue 3

<Tabs groupId="package-manager" persistent items={["npm", "pnpm", "yarn"]}>

```shell tab="npm"
```package-install
npm install @daangn/vue3-icon
```

```shell tab="pnpm"
pnpm add @daangn/vue3-icon
```

```shell tab="yarn"
yarn add @daangn/vue3-icon
```

</Tabs>

</Step>

<Step>
Expand Down Expand Up @@ -957,6 +892,10 @@ yarn add @daangn/vue3-icon

</Steps>

</Tab>

</Tabs>

## 발생할 수 있는 사이드 이펙트

### 정확히 대응되는 리뉴얼된 아이콘이 없는 경우
Expand Down

0 comments on commit 1c16cb9

Please sign in to comment.