docs: assemble 에 대한 문서화를 진행합니다 (#230)

* assemble docs * remove new line in assemble en modx * Update docs/src/pages/docs/api/assemble.en.mdx Co-authored-by: Jonghyeon Ko <[email protected]> * Update docs/src/pages/docs/api/assemble.ko.mdx Co-authored-by: Jonghyeon Ko <[email protected]> --------- Co-authored-by: Jonghyeon Ko <[email protected]>
toss · Aug 16, 2024 · 3a4abca · 3a4abca
1 parent 32fc3f0
commit 3a4abca
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 0 deletions.
diff --git a/docs/src/pages/docs/api/assemble.en.mdx b/docs/src/pages/docs/api/assemble.en.mdx
@@ -0,0 +1,37 @@
+---
+title: assemble
+---
+
+
+import { Sandpack } from '@/components/Sandpack';
+
+
+# assemble
+
+Combine the Korean sentences and characters in the array received as input according to Korean language rules.
+
+```typescript
+function assemble(
+  // An array containing Korean characters and sentences.
+  words: string[]
+): string
+```
+
+
+
+## Demo
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { assemble } from 'es-hangul';
+
+console.log(assemble(['아버지가', ' ', '방ㅇ', 'ㅔ ', '들ㅇ', 'ㅓ갑니다']))
+console.log(assemble(['아버지가', ' ', '방에 ', '들어갑니다']))
+console.log(assemble(['ㅇ', 'ㅏ', 'ㅂ', 'ㅓ', 'ㅈ', 'ㅣ']))
+```
+
+</Sandpack>
+
diff --git a/docs/src/pages/docs/api/assemble.ko.mdx b/docs/src/pages/docs/api/assemble.ko.mdx
@@ -0,0 +1,36 @@
+---
+title: assemble
+---
+
+import { Sandpack } from '@/components/Sandpack';
+
+
+# assemble
+
+인자로 받은 배열에 담긴 한글 문장과 문자를 한글 규칙에 맞게 합성합니다.
+
+```typescript
+function assemble(
+  // 한글 문자와 문장을 담고 있는 배열
+  words: string[]
+): string
+```
+
+
+
+## 사용해보기
+
+<br />
+
+<Sandpack>
+
+```ts index.ts
+import { assemble } from 'es-hangul';
+
+console.log(assemble(['아버지가', ' ', '방ㅇ', 'ㅔ ', '들ㅇ', 'ㅓ갑니다']))
+console.log(assemble(['아버지가', ' ', '방에 ', '들어갑니다']))
+console.log(assemble(['ㅇ', 'ㅏ', 'ㅂ', 'ㅓ', 'ㅈ', 'ㅣ']))
+```
+
+</Sandpack>
+