docs: 문서에서 사용해볼 수 있는 데모 추가 (#210)

* docs: disassembleHangul 및 disassembleHangulToGroups 문서에 데모 추가

* docs: acronymizeHangul 문서에 데모 추가

* docs: extractHangul 문서에 데모 추가

* docs: hangulIncludes 문서에 데모 추가

* chore: changeset 추가

* docs: 누락된 API title 명시

* chore: main sync

* feat: Update disassemble API in documentation

* fix: md -> mdx

* feat: amountToHangul 데모 추가

* feat: getChoseong 데모 추가

* chore: changeset 수정

* feat: romanize, standardizePronunciation, susa 데모 추가

* chore: changeset 수정

* feat: hasBatchim 데모 추가

* feat: canBe 문서에 데모 추가

.changeset/fluffy-mirrors-kiss.md

@@ -0,0 +1,6 @@
+---
+'docs': patch
+---
+
+docs: 문서에서 사용해볼 수 있는 데모를 추가합니다.
+(amountToHangul, disassemble, disassembleToGroups, getChoseong, hasBatchim, romanize, standardizePronunciation, susa)

docs/src/pages/docs/api/amountToHangul.en.md → docs/src/pages/docs/api/amountToHangul.en.mdx

@@ -2,6 +2,8 @@
 title: amountToHangul
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # amountToHangul
 
 Converts numeric amounts to the Korean reading of the [National Institute of Korean Language](https://ko.dict.naver.com/#/correct/korean/info?seq=602) rules.
@@ -20,3 +22,17 @@ amountToHangul('120,030원'); // '일십이만삼십'
 amountToHangul('12345.6789'); // '일만이천삼백사십오점육칠팔구'
 amountToHangul(15_201_100); // '일천오백이십만천백''
 ```
+
+## Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { amountToHangul } from 'es-hangul';
+
+console.log(amountToHangul('15,201,100'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/amountToHangul.ko.md → docs/src/pages/docs/api/amountToHangul.ko.mdx

@@ -2,6 +2,8 @@
 title: amountToHangul
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # amountToHangul
 
 숫자나 문자를 [국립국어원](https://ko.dict.naver.com/#/correct/korean/info?seq=602) 규칙의 한글 읽기 문자열로 변환합니다.
@@ -20,3 +22,17 @@ amountToHangul('120,030원'); // '일십이만삼십'
 amountToHangul('12345.6789'); // '일만이천삼백사십오점육칠팔구'
 amountToHangul(15_201_100); // '일천오백이십만천백''
 ```
+
+## 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { amountToHangul } from 'es-hangul';
+
+console.log(amountToHangul('15,201,100'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/canBe.en.md → docs/src/pages/docs/api/canBe.en.mdx

@@ -2,14 +2,20 @@
 title: canBe
 ---
 
-# canBeChoseong
+import { Sandpack } from '@/components/Sandpack';
+
+# canBe
+
+## canBeChoseong
 
 Check if a given character can be a choseong in Korean.
 
 ```typescript
 function canBeChoseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeChoseong('ㄱ'); // true
 canBeChoseong('ㅃ'); // true
@@ -18,14 +24,30 @@ canBeChoseong('ㅏ'); // false
 canBeChoseong('가'); // false
 ```
 
-# canBeJungseong
+### Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeChoseong } from 'es-hangul';
+
+console.log(canBeChoseong('ㄱ'));
+```
+
+</Sandpack>
+
+## canBeJungseong
 
 Check if a given character can be a jungseong in Korean.
 
 ```typescript
 function canBeJungseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeJungseong('ㅏ'); // true
 canBeJungseong('ㅗㅏ'); // true
@@ -35,14 +57,30 @@ canBeJungseong('ㄱㅅ'); // false
 canBeJungseong('가'); // false
 ```
 
-# canBeJongseong
+### Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeJungseong } from 'es-hangul';
+
+console.log(canBeJungseong('ㅏ'));
+```
+
+</Sandpack>
+
+## canBeJongseong
 
 Check if a given character can be a jongseong in Korean.
 
 ```typescript
 function canBeJongseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeJongseong('ㄱ'); // true
 canBeJongseong('ㄱㅅ'); // true
@@ -51,3 +89,17 @@ canBeJongseong('가'); // false
 canBeJongseong('ㅏ'); // false
 canBeJongseong('ㅗㅏ'); // false
 ```
+
+### Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeJongseong } from 'es-hangul';
+
+console.log(canBeJongseong('ㄱ'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/canBe.ko.md → docs/src/pages/docs/api/canBe.ko.mdx

@@ -2,14 +2,20 @@
 title: canBe
 ---
 
-# canBeChoseong
+import { Sandpack } from '@/components/Sandpack';
+
+# canBe
+
+## canBeChoseong
 
 인자로 받은 문자가 초성으로 위치할 수 있는 문자인지 검사합니다.
 
 ```typescript
 function canBeChoseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeChoseong('ㄱ'); // true
 canBeChoseong('ㅃ'); // true
@@ -18,14 +24,30 @@ canBeChoseong('ㅏ'); // false
 canBeChoseong('가'); // false
 ```
 
-# canBeJungseong
+### 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeJungseong } from 'es-hangul';
+
+console.log(canBeJungseong('ㅏ'));
+```
+
+</Sandpack>
+
+## canBeJungseong
 
 인자로 받은 문자가 중성으로 위치할 수 있는 문자인지 검사합니다.
 
 ```typescript
 function canBeJungseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeJungseong('ㅏ'); // true
 canBeJungseong('ㅗㅏ'); // true
@@ -35,14 +57,30 @@ canBeJungseong('ㄱㅅ'); // false
 canBeJungseong('가'); // false
 ```
 
-# canBeJongseong
+### 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeJungseong } from 'es-hangul';
+
+console.log(canBeJungseong('ㅏ'));
+```
+
+</Sandpack>
+
+## canBeJongseong
 
 인자로 받은 문자가 종성으로 위치할 수 있는 문자인지 검사합니다.
 
 ```typescript
 function canBeJongseong(character: string): boolean;
 ```
 
+### Examples
+
 ```typescript
 canBeJongseong('ㄱ'); // true
 canBeJongseong('ㄱㅅ'); // true
@@ -51,3 +89,17 @@ canBeJongseong('가'); // false
 canBeJongseong('ㅏ'); // false
 canBeJongseong('ㅗㅏ'); // false
 ```
+
+### 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { canBeJongseong } from 'es-hangul';
+
+console.log(canBeJongseong('ㄱ'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/disassemble.en.md → docs/src/pages/docs/api/disassemble.en.mdx

@@ -2,6 +2,8 @@
 title: disassemble
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # disassemble
 
 Completely separates a Hangul string into its individual characters by initial consonants, medial vowels, and final consonants, creating a single string.
@@ -23,3 +25,17 @@ disassemble('값이 비싸다'); // 'ㄱㅏㅂㅅㅇㅣ ㅂㅣㅆㅏㄷㅏ'
 disassemble('ㅘ'); // 'ㅗㅏ'
 disassemble('ㄵ'); // 'ㄴㅈ'
 ```
+
+## Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { disassemble } from 'es-hangul';
+
+console.log(disassemble('값'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/disassemble.ko.md → docs/src/pages/docs/api/disassemble.ko.mdx

@@ -2,6 +2,8 @@
 title: disassemble
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # disassemble
 
 한글 문자열을 글자별로 초성/중성/종성 단위로 완전히 분리하여, 하나의 문자열로 만듭니다.
@@ -23,3 +25,17 @@ disassemble('값이 비싸다'); // 'ㄱㅏㅂㅅㅇㅣ ㅂㅣㅆㅏㄷㅏ'
 disassemble('ㅘ'); // 'ㅗㅏ'
 disassemble('ㄵ'); // 'ㄴㅈ'
 ```
+
+## 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { disassemble } from 'es-hangul';
+
+console.log(disassemble('값'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/disassembleToGroups.en.md → docs/src/pages/docs/api/disassembleToGroups.en.mdx

@@ -2,6 +2,8 @@
 title: disassembleToGroups
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # disassembleToGroups
 
 Completely separate a Hangul string into individual characters based on the initial consonant, medial vowel, and final consonant.
@@ -24,3 +26,17 @@ disassembleToGroups('사과'); // [['ㅅ', 'ㅏ'], ['ㄱ', 'ㅗ', 'ㅏ']]
 disassembleToGroups('ㅘ'); // [['ㅗ', 'ㅏ']]
 disassembleToGroups('ㄵ'); // [['ㄴ', 'ㅈ']]
 ```
+
+## Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { disassembleToGroups } from 'es-hangul';
+
+console.log(disassembleToGroups('사과'));
+```
+
+</Sandpack>

docs/src/pages/docs/api/disassembleToGroups.ko.md → docs/src/pages/docs/api/disassembleToGroups.ko.mdx

@@ -2,6 +2,8 @@
 title: disassembleToGroups
 ---
 
+import { Sandpack } from '@/components/Sandpack';
+
 # disassembleToGroups
 
 한글 문자열을 글자별로 초성/중성/종성 단위로 완전히 분리합니다.
@@ -24,3 +26,17 @@ disassembleToGroups('사과'); // [['ㅅ', 'ㅏ'], ['ㄱ', 'ㅗ', 'ㅏ']]
 disassembleToGroups('ㅘ'); // [['ㅗ', 'ㅏ']]
 disassembleToGroups('ㄵ'); // [['ㄴ', 'ㅈ']]
 ```
+
+## 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { disassembleToGroups } from 'es-hangul';
+
+console.log(disassembleToGroups('사과'));
+```
+
+</Sandpack>