Skip to content

Commit

Permalink
✨ feat(script): add gen doc by gpt
Browse files Browse the repository at this point in the history
  • Loading branch information
summerscar committed Nov 1, 2024
1 parent 494d716 commit 900d0ed
Show file tree
Hide file tree
Showing 21 changed files with 438 additions and 37 deletions.
23 changes: 22 additions & 1 deletion .github/workflows/generate-doc.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
name: Generate doc
run-name: Generate doc
on: [push]
on:
push:
workflow_dispatch:
inputs:
docLevel:
description: "Doc level"
required: true
default: "beginner"
type: choice
options:
- beginner
- intermediate
docTitle:
description: "Doc title"
required: true
type: string

jobs:
update-doc:
runs-on: ubuntu-latest
env:
DOC_LEVEL: ${{ inputs.docLevel }}
DOC_TITLE: ${{ inputs.docTitle }}
AI: ${{ secrets.AI }}
GEMINI_KEY: ${{ secrets.GEMINI_KEY }}
GPT_URL: ${{ secrets.GPT_URL }}
Expand All @@ -16,6 +34,9 @@ jobs:
- name: Install dependencies
run: npm install

- name: Run script:docs-file
run: npm run script:docs-file ${{ env.DOC_TITLE }}

- name: Run script:docs-desc
run: npm run script:docs-desc

Expand Down
2 changes: 1 addition & 1 deletion app/components/pronunciation/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const Pronunciation = ({
return (
<>
{children}{" "}
{tooltip ? (
{tooltip && targetText.length < 10 ? (
<span className="tooltip" data-tip={romanize(targetText)}>
{speakerEl}
</span>
Expand Down
2 changes: 1 addition & 1 deletion app/utils/list-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const _listAllDocs = async (level: string) => {
relativeUrl: path.join(level, ...walkPath, fileName),
relativePath: path.join(...walkPath, file),
title: data.match(/title: (.*)/)?.[1] || fileName,
date: data.match(/date: (\d{4}-\d{2}-\d{2})/)?.[1] || "0",
date: data.match(/date: (.*)/)?.[1] || "0",
};
}),
);
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/单词构成/副词化.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 副词化
author: summerscar
description: 本教程讲解韩语语法中的副词化(p453), 介绍如何将其他词性转化为副词使用。

date: 2024-11-01
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---

# 副词化
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/单词构成/名词化.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 名词化
author: summerscar
description: 本教程讲解韩语语法中的名词化,介绍如何将动词或形容词转化为名词形式。

date: 2024-11-02
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---

# 名词化
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/依存名词.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 依存名词
author: summerscar
description: 本教程讲解韩语依存名词,例如것(事物), 일(事情), 수(方法/能力), 적(方面), 데(地方/情况)等,并配以例句说明其用法和常用搭配,也解释了依存名词需依附动词或形容词使用的特性。

date: 2024-10-11
tags: ['grammar']
last-modified: 1730470851042
last-modified: 1730482859114
---

# 依存名词
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/冠形词形词尾.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 冠形词形词尾
author: summerscar
description: 本教程讲解韩语冠形词形词尾,目前内容待补充 (p283)。

date: 2024-11-01
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---
# 冠形词形词尾
TODO: p283
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/引用.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 引用
author: summerscar
description: 本教程尚未完成(TODO:429),标题为“引用”,作者是summerscar,内容关于韩语学习中的引用方法。

date: 2024-11-05
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---

# 引用
Expand Down
4 changes: 1 addition & 3 deletions mdx/beginner/语法基础/指示词.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@
title: 指示词
author: summerscar
description: 本教程讲解韩语指示词(지시어),包含指示连体词(이/그/저/느),指示代名词(것/곳/쪽),指示形容词(이렇다/그렇다/저렇다/어떻다)及其变形,以及指示动词(이러다/그러다/저러다/어쩌다),用于指示事物、场所、方向等,并根据距离远近区分使用。

date: 2024-10-17
tags: ['grammar']
last-modified: 1730470851042

last-modified: 1730482859114
---

# 指示词
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/数词.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 数词
author: summerscar
description: 本教程讲解韩语数词系统,包括固有数词和汉字数词。它介绍了两种系统的构成、使用规则、不同场景下的用法(如时间、年龄、金钱等),以及模糊数字和序数词的表达方式。

date: 2024-10-16
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---

# 数词
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/语序与构造.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 语顺与构造
author: summerscar
description: 本教程讲解韩语句子结构,核心是主宾谓语序。涵盖基本句式(主语+形容词/自动词/补语+되다/宾语+他动词/名词+이다)和按说话目的分类的五种句子类型(陈述、疑问、命令、共动、感叹句),并分别列举了不同敬语形式的例句。

date: 2024-10-10
tags: ['grammar']
last-modified: 1730470851042
last-modified: 1730482859114
---

# 文章的语顺和构造
Expand Down
3 changes: 1 addition & 2 deletions mdx/beginner/语法基础/语末词尾.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: 语末词尾
author: summerscar
description: 本教程讲解韩语语法中的终结词尾,涵盖时制、敬语、回想等方面,并计划补充更多内容。

date: 2024-11-02
tags:
last-modified: 1730470851042
last-modified: 1730482859114
---
# 终结词尾
【用言一尊敬一過去一意志 · 推量一語尾】
Expand Down
65 changes: 65 additions & 0 deletions mdx/beginner/语法形态/-데.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: -(ㄴ/은/는)데
author: summerscar
description:
date: 2024-11-01T16:18:54.891Z
tags:
last-modified: 1730482859114
---

# -(ㄴ/은/는)데

## 句型

* **形容词后:** 词干 + -(ㄴ/은)데
* 以子音结尾:-(은)데
* 以母音结尾:-(ㄴ)데
* **动词/이다/있다后:** 词干 + -(ㄴ/는)데
* 以子音结尾:-(는)데
* 以母音结尾:-(는)데
* 있다: 있는데
* 이다: 인데


## 含义

* **提出背景/铺垫,引出下文。** 下文通常是与前文形成对比、转折,提出请求或建议,或是表达不满、意外等情绪。
* **解说说明某一状况。** 类似于“是这样的…”、“(情况)是这样, …”
* **委婉地表达自己的意见或感受。**


## 例子

**1. 提出背景/铺垫,引出下文**

* <Speak>날씨가 좋은데 같이 공원에 갈래요?</Speak> (天气很好,一起去公园吗?)
* <Speak>배가 고픈데 뭐 좀 먹을까요?</Speak> (肚子饿了,吃点什么吧?)
* <Speak>시간이 없는데 빨리 가야겠어요.</Speak> (没时间了,得赶紧走了。)

**2. 解说说明某一状况**

* <Speak>저는 학생인데 아르바이트를 하고 있어요.</Speak> (我是学生,正在打工。)
* <Speak>이 옷은 예쁜데 너무 비싸요.</Speak> (这件衣服很漂亮,但是太贵了。)
* <Speak>오늘은 바쁜데 내일 만날 수 있어요?</Speak> (今天很忙,明天可以见面吗?)


**3. 委婉地表达自己的意见或感受**

* <Speak>좀 피곤한데 먼저 갈게요.</Speak> (有点累了,我先走了。)
* <Speak>맛있는데 조금 짠 것 같아요.</Speak> (好吃,但好像有点咸。)
* <Speak>재미있는데 너무 길어요.</Speak> (很有趣,但是太长了。)



## 注意

* “-는데” 不能用于命令句和共动句。
* 当后续句子表达与前文相反或出乎意料的内容时,语气较为强烈。
* 后续句子常常省略主语,因为主语通常与前句相同。



## 类似语法

* -지만: 表示转折,与 “-는데” 相似,但 “-지만” 语气更为强烈,强调对比和转折。 "-는데" 更侧重于引出下文,而 "-지만" 更侧重于前后的对比。 例如: "날씨가 좋은데 집에 있어요." (天气很好,(可是)我待在家里。) vs. "날씨가 좋지만 집에 있어야 해요." (天气很好,但是我必须待在家里。)
* -고: 表示并列,"-는데"有时也可表示并列,但更强调前句是后句的原因或背景。 例如: "밥을 먹고 영화를 봤어요." (吃了饭,看了电影。) vs. "밥을 먹었는데 영화를 볼까요?" (吃了饭,去看电影吗?)
65 changes: 65 additions & 0 deletions mdx/beginner/语法形态/-듯이.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: -(ㄴ/ㄹ/은/는)듯이
author: summerscar
description:
date: 2024-11-01T16:30:03.645Z
tags:
---

# -(ㄴ/ㄹ/은/는)듯이

## 句型

* **形容词词干后:**
* 以子音结尾: 词干 + ㄴ 듯이
* 以母音结尾: 词干 + ㄴ 듯이
* **动词词干后:**
*`` 结尾: 词干 + 듯이
* 以其他子音结尾: 词干 + 는 듯이
* 以母音结尾: 词干 + 는 듯이
* **名词后:**
* 은/는 듯이 (与名词的主格助词相同)

## 含义

该语法表示“像...一样”、“如同...一般”、“仿佛...”等含义,用于比喻某事物或动作的状态、样子,类似于汉语的“好像”、“似乎”、“犹如”。

* 表达与前面内容相似的感觉、状态。
* 表达不确定的推测,认为某事可能如此。
* 表达生动形象的比喻。

## 例子

**表达与前面内容相似的感觉、状态:**

1. <Speak>죽은 듯이 고요하다</Speak> (像死了一样安静)
2. <Speak>아픈 듯이 얼굴이 창백하다</Speak> (好像很疼,脸色苍白)
3. <Speak>꿈을 꾸는 듯이 미소를 짓다</Speak> (像做梦一样微笑)


**表达不确定的推测,认为某事可能如此:**

1. <Speak>비가 올 듯이 하늘이 흐리다</Speak> (好像要下雨,天空阴沉)
2. <Speak>그는 화가 난 듯이 말했다</Speak> (他好像生气了那样说话)
3. <Speak>뭔가 숨기는 듯이 행동했다</Speak> (好像隐瞒了什么那样行动)


**表达生动形象的比喻:**

1. <Speak>구름 위를 걷는 듯이 기분이 좋다</Speak> (心情好得像走在云上一样)
2. <Speak>별처럼 반짝이는 듯이 아름답다</Speak> (像星星一样闪闪发光,美丽极了)
3. <Speak>날개가 달린 듯이 가볍다</Speak> (轻得像插上了翅膀一样)


## 注意

* `-(ㄴ/ㄹ/은/는)듯이``-(ㄴ/는) 것처럼` 更强调主观感受,语气更委婉。
* `-(ㄴ/ㄹ/은/는)듯이` 可以与一些动词连用,例如 `보이다` (看起来), `느껴지다` (感觉), `들리다` (听起来) 等,进一步加强“好像”的意味。

## 类似语法

* `-(ㄴ/는) 것처럼`: 与 `-(ㄴ/ㄹ/은/는)듯이` 含义相近,但 `-(ㄴ/는) 것처럼` 更强调客观事实,语气更肯定。 `-(ㄴ/ㄹ/은/는)듯이` 更侧重说话者的主观感受,语气更委婉。
* `-같이`: 表示“像...一样”,用法比较广泛,可以用于比较各种事物或动作,语气比较平淡。
* `-(ㄴ/ㄹ/은/는) 듯`: 与 `-(ㄴ/ㄹ/은/는)듯이` 含义基本相同,`-(ㄴ/ㄹ/은/는) 듯` 更口语化,常用于非正式场合。


71 changes: 71 additions & 0 deletions mdx/beginner/语法形态/〜ㄴ 것 같다.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: 〜(으)ㄴ 것 같다
author: summerscar
description:
date: 2024-11-01T16:55:46.446Z
tags:
---

# 【〜(으)ㄴ 것 같다】

## 句型

* **形容词词干后:** 词干 + 〜ㄴ 것 같다
* **以ㄹ结尾的形容词词干后:** 词干 + 〜ㄴ 것 같다 (ㄹ脱落)
* **动词词干后:** 词干 + 〜는 것 같다
* **以있다/없다 结尾的形容词后:** 있다/없다 + 는 것 같다
* **过去时态:** 词干 + 〜았/었/였던 것 같다


## 含义

该语法表示说话者的推测或猜测,类似于汉语的“好像...”、“像是...”、“似乎...”、“感觉...”等。它表达的并非确定的判断,而是基于某种依据的主观感受。根据语境不同,可以表达以下几种含义:

* **推测客观事实:** 推测某件事情的状态或性质。
* **推测主观感受:** 推测某人/某事物的心理状态或感受。
* **委婉表达:** 用推测的语气来表达自己的意见或请求,使语气更加委婉、柔和。
* **不确定记忆:** 表示对过去的记忆不太确定。


## 例子

**推测客观事实**

1. <Speak>날씨가 좋은 것 같아요.</Speak> (天气好像很好。)
2. <Speak>그 식당 음식이 맛있는 것 같아요.</Speak> (那家餐厅的菜好像很好吃。)
3. <Speak>저 사람은 학생인 것 같아요.</Speak> (那个人好像是个学生。)

**推测主观感受**

1. <Speak>그녀는 슬픈 것 같아요.</Speak> (她好像很悲伤。)
2. <Speak>그는 피곤한 것 같아요.</Speak> (他好像很疲惫。)
3. <Speak>아이는 배고픈 것 같아요.</Speak> (孩子好像饿了。)


**委婉表达**

1. <Speak>제 생각에는 좀 더 기다리는 게 좋을 것 같아요.</Speak> (我觉得再等一会儿比较好。)
2. <Speak>이 옷은 당신에게 잘 어울릴 것 같아요.</Speak> (这件衣服你穿应该会很合适。)
3. <Speak>내일 비가 올 것 같아요. 우산을 챙기세요.</Speak> (明天好像要下雨。带好雨伞吧。)

**不确定记忆**

1. <Speak>어렸을 때 그곳에 간 적이 있었던 것 같아요.</Speak> (我小时候好像去过那里。)
2. <Speak>그 영화를 본 적이 있었던 것 같아요.</Speak> (我好像看过那部电影。)
3. <Speak>그 사람을 어디서 만났던 것 같아요.</Speak> (我好像在哪里见过那个人。)


## 注意

* 〜(으)ㄴ 것 같다 比 〜(으)ㄹ 것 같다 语气更委婉,更不确定。〜(으)ㄹ 것 같다 则更偏向于对未来的预测。
* 〜(으)ㄴ 것 같다 强调的是说话者基于某种依据的主观感受,即使推测的内容与事实相符,也不代表说话者完全确定。


## 类似语法

* **〜(으)ㄹ 것 같다:** 表示对未来的推测或预测。
* **〜(으)ㄴ/는 모양이다:** 表示根据观察到的情况进行推测,语气比〜(으)ㄴ 것 같다 更客观一些。
* **〜(으)ㄴ/는데:** 可以用来表示推测,但更侧重于根据某种情况推导出某种结论。
* 〜(으)ㄹ 듯하다: 与〜(으)ㄹ 것 같다 含义相近,但语气更书面化。


Loading

0 comments on commit 900d0ed

Please sign in to comment.