remark-cjk-friendly 1.2.2 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/dist/index.d.ts +3 -2
- package/dist/index.js +10 -10
- package/package.json +9 -11
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ A [remark](https://github.com/remarkjs/remark) plugin to make Markdown emphasis
|
|
|
8
8
|
|
|
9
9
|
<span lang="zh-Hans-CN">一个 [remark](https://github.com/remarkjs/remark) 插件,用于使 CommonMark(和 MDX)的强调标记(`**`)能够正确支持中文、日语和韩语文本。</span>
|
|
10
10
|
|
|
11
|
-
<span lang="ko">CommonMark(및 MDX)의 강조 표시(`**`)를 한국어,
|
|
11
|
+
<span lang="ko">CommonMark(및 MDX)의 강조 표시(`**`)를 한국어, 일본어, 중국어와 호환되도록 만드는 [remark](https://github.com/remarkjs/remark) 플러그인.</span>
|
|
12
12
|
|
|
13
13
|
> [!NOTE]
|
|
14
14
|
> This package does not support the strikethrough syntax (`~~`) in GFM (GitHub Flavored Markdown). If you want to support it, please use [`remark-cjk-friendly-gfm-strikethrough`](https://npmjs.com/package/remark-cjk-friendly-gfm-strikethrough) along with this package.
|
|
@@ -19,7 +19,7 @@ A [remark](https://github.com/remarkjs/remark) plugin to make Markdown emphasis
|
|
|
19
19
|
>
|
|
20
20
|
> <span lang="ko">이 패키지는 GitHub Flavored Markdown(GFM)의 취소선(`~~`)을 지원하지 않습니다. 지원하고 싶은 경우에는 [`remark-cjk-friendly-gfm-strikethrough`](https://npmjs.com/package/remark-cjk-friendly-gfm-strikethrough)를 함께 사용해 주세요.</span>
|
|
21
21
|
|
|
22
|
-
## Problem / <span lang="ja">問題</span> / <span lang="zh-Hans-CN">问题</span> / <span lang="ko"
|
|
22
|
+
## Problem / <span lang="ja">問題</span> / <span lang="zh-Hans-CN">问题</span> / <span lang="ko">문제</span>
|
|
23
23
|
|
|
24
24
|
CommonMark has a problem that the following emphasis marks `**` are not recognized as emphasis marks in Japanese, Chinese, and Korean.
|
|
25
25
|
|
|
@@ -27,7 +27,7 @@ CommonMark has a problem that the following emphasis marks `**` are not recogniz
|
|
|
27
27
|
|
|
28
28
|
<span lang="zh-Hans-CN">CommonMark存在以下问题:在中文、日语和韩语文本中,强调标记`**`不会被识别为强调标记。</span>
|
|
29
29
|
|
|
30
|
-
<span lang="ko">CommonMark는
|
|
30
|
+
<span lang="ko">CommonMark는 한국어, 일본어, 중국어에서 다음과 같은 강조 표시 `**`가 강조 표시로 인식되지 않는 문제가 있습니다.</span>
|
|
31
31
|
|
|
32
32
|
```md
|
|
33
33
|
**このアスタリスクは強調記号として認識されず、そのまま表示されます。**この文のせいで。
|
|
@@ -59,7 +59,7 @@ CommonMark issue: https://github.com/commonmark/commonmark-spec/issues/650
|
|
|
59
59
|
|
|
60
60
|
https://tats-u.github.io/markdown-cjk-friendly
|
|
61
61
|
|
|
62
|
-
## When should I use this? / <span lang="ja">このパッケージを使うべき場合</span> / <span lang="zh-Hans-CN">何时使用此包</span> / <span lang="ko">이 패키지를
|
|
62
|
+
## When should I use this? / <span lang="ja">このパッケージを使うべき場合</span> / <span lang="zh-Hans-CN">何时使用此包</span> / <span lang="ko">이 패키지를 사용해야 하는 경우</span>
|
|
63
63
|
|
|
64
64
|
If you are an engineer who must handle Chinese, Japanese, and Korean content that cannot be fully supervised, it is strongly recommended to use this package (adopt this specification instead of plain CommonMark or GFM). "Cannot be fully supervised" refers to situations such as:
|
|
65
65
|
|
|
@@ -75,7 +75,7 @@ Additionally, if you are creating Markdown-related software or services primaril
|
|
|
75
75
|
1. <span lang="ja">ユーザまたはAIが作成したコンテンツをそのまま表示する必要がある場合</span>
|
|
76
76
|
2. <span lang="ja">翻訳者に、このCommonMarkの仕様を理解していない人も多く、なおかつリアルタイムで本番同様の描画プレビューを提供できず、`<strong>`タグを許可していない場合</span>
|
|
77
77
|
- <span lang="ja">翻訳にCrowdin・Transifexなどの翻訳サービスを使っている場合</span>
|
|
78
|
-
- <span lang="ja">翻訳の品質に責任を負っている人が非エンジニアである、または
|
|
78
|
+
- <span lang="ja">翻訳の品質に責任を負っている人が非エンジニアである、またはCommonMarkのこの挙動を理解していない場合</span>
|
|
79
79
|
|
|
80
80
|
<span lang="ja">また、あなたが主に日本人・中国人・韓国人のいずれかまたは全てを対象としたMarkdown関連のソフトウェアやサービスを作成する場合も、このパッケージを使う(この仕様を採用する)ことを強く推奨します。</span>
|
|
81
81
|
|
|
@@ -88,36 +88,36 @@ Additionally, if you are creating Markdown-related software or services primaril
|
|
|
88
88
|
|
|
89
89
|
<span lang="zh-Hans-CN">此外,如果您正在创建主要面向中国人、日本人或韩国人(或全部)的Markdown相关软件或服务,也强烈建议采用此规范。</span>
|
|
90
90
|
|
|
91
|
-
<span lang="ko">엔지니어로서 완전히 감독할 수 없는 일본어, 중국어, 한국어 콘텐츠를 다뤄야 하는
|
|
91
|
+
<span lang="ko">엔지니어로서 완전히 감독할 수 없는 일본어, 중국어, 한국어 콘텐츠를 다뤄야 하는 경우 이 패키지를 사용(일반 CommonMark나 GFM 대신 이 사양을 채택)할 것을 강력히 권장합니다. '완전히 감독할 수 없는'이란 다음과 같은 상황을 의미합니다.</span>
|
|
92
92
|
|
|
93
93
|
1. <span lang="ko">사용자 또는 AI가 생성한 콘텐츠를 그대로 표시해야 하는 경우</span>
|
|
94
|
-
2. <span lang="ko">많은 번역자가
|
|
94
|
+
2. <span lang="ko">많은 번역자가 CommonMark의 동작을 이해하지 못하고, 실시간으로 실제 환경과 유사한 렌더링 미리보기를 제공할 수 없으며, `<strong>` 태그가 허용되지 않는 경우</span>
|
|
95
95
|
- <span lang="ko">Crowdin이나 Transifex 같은 번역 서비스를 사용하는 경우</span>
|
|
96
|
-
- <span lang="ko">번역 품질에 책임을 지는 사람이 엔지니어가 아니거나
|
|
96
|
+
- <span lang="ko">번역 품질에 책임을 지는 사람이 엔지니어가 아니거나 CommonMark의 동작을 이해하지 못하는 경우</span>
|
|
97
97
|
|
|
98
|
-
<span lang="ko">또한, 주로 일본어,
|
|
98
|
+
<span lang="ko">또한, 주로 한국어, 일본어, 중국어 사용자(또는 모두)를 대상으로 하는 Markdown 관련 소프트웨어나 서비스를 만들고 있다면 이 패키지를 사용(이 사양을 채택)할 것을 강력히 권장합니다.</span>
|
|
99
99
|
|
|
100
|
-
### Example of 1. (Chinese) / <span lang="ja">1.の例(中国語)</span> / <span lang="zh-Hans-CN">1.的例子</span> / <span lang="ko">1.의
|
|
100
|
+
### Example of 1. (Chinese) / <span lang="ja">1.の例(中国語)</span> / <span lang="zh-Hans-CN">1.的例子</span> / <span lang="ko">1.의 예시(중국어)</span>:
|
|
101
101
|
|
|
102
102
|
❌️Plain CommonMark / <span lang="ja">素のCommonMark</span> / <span lang="zh-Hans-CN">原生CommonMark</span> / <span lang="ko">기본 CommonMark</span>:
|
|
103
103
|
|
|
104
104
|

|
|
105
105
|
|
|
106
|
-
✅️With this spec / <span lang="ja">本規格</span> / <span lang="zh-Hans-CN">这个规范</span> / <span lang="ko">이
|
|
106
|
+
✅️With this spec / <span lang="ja">本規格</span> / <span lang="zh-Hans-CN">这个规范</span> / <span lang="ko">이 사양</span>:
|
|
107
107
|
|
|
108
108
|

|
|
109
109
|
|
|
110
110
|
Image source: [CherryHQ/cherry-studio#4119](https://github.com/CherryHQ/cherry-studio/pull/4119)
|
|
111
111
|
|
|
112
|
-
## Runtime Requirements / <span lang="ja">実行環境の要件</span> / <span lang="zh-Hans-CN">运行环境要求</span> / <span lang="ko"
|
|
112
|
+
## Runtime Requirements / <span lang="ja">実行環境の要件</span> / <span lang="zh-Hans-CN">运行环境要求</span> / <span lang="ko">런타임 요구 사항</span>
|
|
113
113
|
|
|
114
|
-
This package is ESM-only. It requires Node.js
|
|
114
|
+
This package is ESM-only. It requires Node.js 18 or later. (I have only tested it on 20 and later. There is no factor that would prevent it from working on 18, but I do not guarantee its operation on 18.)
|
|
115
115
|
|
|
116
|
-
<span lang="ja">本パッケージはESM専用です。Node.js
|
|
116
|
+
<span lang="ja">本パッケージはESM専用です。Node.js 18以上が必要です。(動作検証は20以降でのみ行っています。18での動作を妨げる要因はありませんが、動作の保証はありません)</span>
|
|
117
117
|
|
|
118
|
-
<span lang="zh-Hans-CN">此包仅支持ESM。需要Node.js
|
|
118
|
+
<span lang="zh-Hans-CN">此包仅支持ESM。需要Node.js 18或更高版本。(我只测试了20及以后的版本。没有因素会阻止它在18上工作,但我不保证在18上的操作。)</span>
|
|
119
119
|
|
|
120
|
-
<span lang="ko"
|
|
120
|
+
<span lang="ko">본 패키지는 ESM 전용입니다. Node.js 18 이상이 필요합니다. (동작 검증은 20 이후 버전에서만 수행했습니다. 18에서 동작을 방해하는 요인은 없으나, 동작을 보장하지는 않습니다)</span>
|
|
121
121
|
|
|
122
122
|
## Installation / <span lang="ja">インストール</span> / <span lang="zh-Hans-CN">安装</span> / <span lang="ko">설치</span>
|
|
123
123
|
|
|
@@ -139,7 +139,7 @@ If you use another package manager, please replace `npm install` with the comman
|
|
|
139
139
|
|
|
140
140
|
<span lang="zh-Hans-CN">如果使用其他包管理器,请将 `npm install` 替换为当时包管理器的命令(例如:`pnpm add`、`yarn add`)。</span>
|
|
141
141
|
|
|
142
|
-
<span lang="ko"
|
|
142
|
+
<span lang="ko">npm이 아닌 다른 패키지 매니저를 사용하는 경우 `npm install`을 해당 패키지 매니저의 명령어(예: `pnpm add`, `yarn add`)로 바꿔 주세요.</span>
|
|
143
143
|
|
|
144
144
|
## Usage / <span lang="ja">使い方</span> / <span lang="zh-Hans-CN">用法</span> / <span lang="ko">사용법</span>
|
|
145
145
|
|
|
@@ -176,7 +176,7 @@ For MDX, add `remarkCjkFriendly` to the `remarkPlugins` array in the config obje
|
|
|
176
176
|
|
|
177
177
|
<span lang="zh-Hans-CN">对于 MDX,将 `remarkCjkFriendly` 添加到配置对象的 `remarkPlugins` 数组中。</span>
|
|
178
178
|
|
|
179
|
-
<span lang="ko">MDX의
|
|
179
|
+
<span lang="ko">MDX의 경우 설정 객체의 `remarkPlugins` 배열에 `remarkCjkFriendly`를 추가해 주세요.</span>
|
|
180
180
|
|
|
181
181
|
```js
|
|
182
182
|
const someMdxConfig = {
|
|
@@ -191,7 +191,7 @@ In [Rspress](https://rspress.dev/guide/basic/use-mdx#disabling-the-rust-version-
|
|
|
191
191
|
|
|
192
192
|
<span lang="zh-CN">在[Rspress](https://rspress.dev/zh/guide/basic/use-mdx#%E5%85%B3%E9%97%AD-rust-%E7%89%88%E6%9C%AC%E7%BC%96%E8%AF%91%E5%99%A8)和[Next.js(`@next/mdx`)](https://nextjs.org/docs/pages/building-your-application/configuring/mdx#using-the-rust-based-mdx-compiler-experimental)中,您可能需要将`mdxRs`设置为`false`,以使Rspress使用基于JavaScript且可进行猴子补丁的解析器。</span>
|
|
193
193
|
|
|
194
|
-
<span lang="ko">[Rspress](https://rspress.dev/guide/basic/use-mdx#disabling-the-rust-version-compiler)와 [Next.js(`@next/mdx`)](https://nextjs.org/docs/pages/building-your-application/configuring/mdx#using-the-rust-based-mdx-compiler-experimental)에서는 `mdxRs`를 `false`로 설정하여 Rspress가 JavaScript 기반이며 몽키 패치가 가능한 파서를 사용하도록 해야 할
|
|
194
|
+
<span lang="ko">[Rspress](https://rspress.dev/guide/basic/use-mdx#disabling-the-rust-version-compiler)와 [Next.js(`@next/mdx`)](https://nextjs.org/docs/pages/building-your-application/configuring/mdx#using-the-rust-based-mdx-compiler-experimental)에서는 `mdxRs`를 `false`로 설정하여 Rspress가 JavaScript 기반이며 몽키 패치가 가능한 파서를 사용하도록 해야 할 수 있습니다.</span>
|
|
195
195
|
|
|
196
196
|
## Compatibility with the other languages / <span lang="ja">他言語との互換性</span> / <span lang="zh-Hans-CN">与其他语言的兼容性</span> / <span lang="ko">다른 언어와의 호환성</span>
|
|
197
197
|
|
|
@@ -201,9 +201,9 @@ This modification of the specification does not affect the other languages than
|
|
|
201
201
|
|
|
202
202
|
<span lang="zh-Hans-CN">除中文、日文和韩文外,建议的规范变更不会影响其他语言。请放心使用此软件包,因为如果您的应用程序或文档包含其他语言的翻译或内容,也不会受到影响。我保证,即使使用此软件包(修正建议),remark 仍然会为 0.31.2 版本的所有 CommonMark 测试用例输出相同的 HTML。</span>
|
|
203
203
|
|
|
204
|
-
<span lang="ko"
|
|
204
|
+
<span lang="ko">이 사양 변경 제안은 한국어, 일본어, 중국어 이외의 언어에는 영향을 미치지 않습니다. 애플리케이션이나 문서에 다른 언어의 번역이나 콘텐츠가 포함되어 있어도 영향을 받지 않으므로 안심하고 본 패키지를 사용하시기 바랍니다. 본 패키지(수정안)를 사용해도 0.31.2 시점의 모든 CommonMark 테스트 케이스에서 remark가 동일한 HTML을 출력하는 것을 보장합니다.</span>
|
|
205
205
|
|
|
206
|
-
## Specification / <span lang="ja">規格書</span> / <span lang="zh-Hans-CN">规范</span> / <span lang="ko"
|
|
206
|
+
## Specification / <span lang="ja">規格書</span> / <span lang="zh-Hans-CN">规范</span> / <span lang="ko">설명서</span>
|
|
207
207
|
|
|
208
208
|
https://github.com/tats-u/markdown-cjk-friendly/blob/main/specification.md (English)
|
|
209
209
|
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
//#region src/index.d.ts
|
|
1
2
|
/**
|
|
2
3
|
* Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
|
|
3
4
|
*/
|
|
4
5
|
declare function remarkCjkFriendly(this: unknown): void;
|
|
5
|
-
|
|
6
|
-
export { remarkCjkFriendly as default };
|
|
6
|
+
//#endregion
|
|
7
|
+
export { remarkCjkFriendly as default };
|
package/dist/index.js
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
// src/index.ts
|
|
2
1
|
import { cjkFriendlyExtension } from "micromark-extension-cjk-friendly";
|
|
2
|
+
|
|
3
|
+
//#region src/index.ts
|
|
4
|
+
/**
|
|
5
|
+
* Make Markdown emphasis (`**`) in CommonMark more friendly with Chinese, Japanese, and Korean (CJK).
|
|
6
|
+
*/
|
|
3
7
|
function remarkCjkFriendly() {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
// biome-ignore lint/suspicious/noAssignInExpressions: base plugin (remark-gfm) already does this
|
|
7
|
-
data.micromarkExtensions || (data.micromarkExtensions = [])
|
|
8
|
-
);
|
|
9
|
-
micromarkExtensions.push(cjkFriendlyExtension());
|
|
8
|
+
const data = this.data();
|
|
9
|
+
(data.micromarkExtensions || (data.micromarkExtensions = [])).push(cjkFriendlyExtension());
|
|
10
10
|
}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
};
|
|
11
|
+
|
|
12
|
+
//#endregion
|
|
13
|
+
export { remarkCjkFriendly as default };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "remark-cjk-friendly",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -35,11 +35,11 @@
|
|
|
35
35
|
"description": "remark plugin to make Markdown emphasis (`**`) in CommonMark (and MDX) more friendly with Chinese, Japanese, and Korean (CJK)",
|
|
36
36
|
"sideEffects": false,
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"micromark-extension-cjk-friendly": ""
|
|
38
|
+
"micromark-extension-cjk-friendly": "2.0.0"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@mdx-js/mdx": "^3.1.
|
|
42
|
-
"rehype-stringify": "10.0.1",
|
|
41
|
+
"@mdx-js/mdx": "^3.1.1",
|
|
42
|
+
"rehype-stringify": "^10.0.1",
|
|
43
43
|
"remark": "^15.0.1",
|
|
44
44
|
"remark-gfm": "^4.0.1",
|
|
45
45
|
"remark-parse": "^11.0.0",
|
|
@@ -56,15 +56,13 @@
|
|
|
56
56
|
}
|
|
57
57
|
},
|
|
58
58
|
"engines": {
|
|
59
|
-
"node": ">=
|
|
59
|
+
"node": ">=18"
|
|
60
60
|
},
|
|
61
61
|
"scripts": {
|
|
62
|
-
"build
|
|
63
|
-
"build": "
|
|
64
|
-
"
|
|
65
|
-
"dev:
|
|
66
|
-
"dev": "tsup --watch",
|
|
67
|
-
"dev:lib": "tsup --watch",
|
|
62
|
+
"build": "tsdown",
|
|
63
|
+
"build:lib": "tsdown",
|
|
64
|
+
"dev": "tsdown --watch",
|
|
65
|
+
"dev:lib": "tsdown --watch",
|
|
68
66
|
"test": "vitest run",
|
|
69
67
|
"test:lib": "vitest run",
|
|
70
68
|
"test:up": "vitest -u",
|