Markdown packages in CommonMark revision candidate compatible with Chinese, Japanese, and Korean (CJK)
markdown-it-cjk-friendlyremark-cjk-friendlymarkdown-it-cj-friendly(Deprecated; switch to
markdown-it-cjk-friendly)
- Tweak specifications
- Port for non-JavaScript implementations
See specification.md.
specification.md（英語） を参照してください。
参考 specification.md（英文）。
specification.md（영어）를 참고해 주시기 바라요.
- implementers-tips.md (English)
- ranges.md (English)
CommonMark has a problem that the following emphasis marks ** are not recognized as emphasis marks in Japanese,Chinese, and Korean.
CommonMarkには、日本語・中国語・韓国語内の次のような強調記号(**)が強調記号として認識されない問題があります。
CommonMark存在以下问题：在中文、日语和韩语文本中，强调标记**不会被识别为强调标记。
CommonMark는 일본어와 중국어에서 다음과 같은 강조 표시 **가 강조 표시로 인식되지 않는 문제가 있습니다.
**このアスタリスクは強調記号として認識されず、そのまま表示されます。**この文のせいで。
**该星号不会被识别，而是直接显示。**这是因为它没有被识别为强调符号。
**이 별표는 강조 표시로 인식되지 않고 그대로 표시됩니다(이 괄호 때문에)**이 문장 때문에.This problem occurs because the character just inside the ** is a (Japanese or Chinese) punctuation mark (。) or parenthesis and the character just outside is not a space or punctuation mark.
これが起こった原因は、終了側の**のすぐ内側が約物（。やカッコ）、かつ外側が約物や空白以外の文字であるためです。
这个问题是因为在**的结束部分，内侧字符是标点符号（。）或括号，而外侧字符不是空格或标点符号。
이 문제는 ** 바로 안쪽의 문자가 (일본어나 중국어) 문장 부호(。) 또는 괄호이고 바깥쪽 문자가 공백이나 문장 부호가 아니기 때문에 발생합니다.
Of course, not only the end side but also the start side has the same issue.
もちろん終了側だけでなく、開始側も同様の問題が存在します。
当然，不仅是结束侧，开始侧也存在同样的问题。
물론 끝나는 부분뿐만 아니라 시작하는 부분에서도 동일한 문제가 있습니다.
CommonMark issue: commonmark/commonmark-spec#650
Who should adopt this specifications instead of the original CommonMark or GFM? / 元のCommonMarkやGFMの代わりにこの仕様を採用べき人 / 谁应该采用这个规范而不是原始的CommonMark或GFM？ / 누가 원래의 CommonMark나 GFM 대신 이 사양을 채택해야 하는가?
If you are an engineer who must handle Japanese, Chinese, and Korean content that cannot be fully supervised, it is strongly recommended to adopt this specification instead of plain CommonMark or GFM. "Cannot be fully supervised" refers to situations such as:
- When you need to display user-generated or AI-generated content as-is
- When many translators do not understand this CommonMark behavior, and you cannot provide real-time rendering previews similar to production, and
<strong>tags are not allowed- When using translation services like Crowdin or Transifex
- When the person responsible for translation quality is not an engineer or does not understand this CommonMark behavior
Additionally, if you are creating Markdown-related software or services primarily targeting Japanese, Chinese, or Korean users (or all of them), it is strongly recommended to adopt this specification.
もしエンジニアであるあなたが全てに監修を入れられない日本語・中国語・韓国語のコンテンツを扱わなければならない場合、素のCommonMarkやGFMではなく、この仕様を採用することを強く推奨します。「全てに監修を入れられない」というのは、例えば次のようなものを指します。
- ユーザまたはAIが作成したコンテンツをそのまま表示する必要がある場合
- 翻訳者に、このCommonMarkの仕様を理解していない人も多く、なおかつリアルタイムで本番同様の描画プレビューを提供できず、
<strong>タグを許可していない場合- 翻訳にCrowdin・Transifexなどの翻訳サービスを使っている場合
- 翻訳の品質に責任を負っている人が非エンジニアである、またはComonMarkのこの挙動を理解していない場合
また、あなたが主に日本人・中国人・韓国人のいずれかまたは全てを対象としたMarkdown関連のソフトウェアやサービスを作成する場合も、この仕様を採用することを強く推奨します。
如果作为工程师的您必须处理无法全面监督的日文、中文和韩文内容，强烈建议采用此规范，而不是普通的CommonMark或GFM。"无法全面监督"指的是以下情况：
- 当需要按原样显示用户生成或AI生成的内容时
- 当许多翻译人员不理解这个CommonMark行为，而且无法提供类似生产环境的实时渲染预览，并且不允许使用
<strong>标签时- 当使用Crowdin或Transifex等翻译服务时
- 当负责翻译质量的人不是工程师或不理解这个CommonMark行为时
此外，如果您正在创建主要面向日本人、中国人或韩国人（或全部）的Markdown相关软件或服务，也强烈建议采用此规范。
엔지니어로서 완전히 감독할 수 없는 일본어, 중국어, 한국어 콘텐츠를 다뤄야 하는 경우, 일반 CommonMark나 GFM 대신 이 사양을 채택할 것을 강력히 권장합니다. "완전히 감독할 수 없는"이란 다음과 같은 상황을 의미합니다:
- 사용자 또는 AI가 생성한 콘텐츠를 그대로 표시해야 하는 경우
- 많은 번역자가 이 CommonMark 동작을 이해하지 못하고, 실시간으로 실제 환경과 유사한 렌더링 미리보기를 제공할 수 없으며,
<strong>태그가 허용되지 않는 경우- Crowdin이나 Transifex 같은 번역 서비스를 사용하는 경우
- 번역 품질에 책임을 지는 사람이 엔지니어가 아니거나 이 CommonMark 동작을 이해하지 못하는 경우
또한, 주로 일본어, 중국어, 한국어 사용자(또는 모두)를 대상으로 하는 Markdown 관련 소프트웨어나 서비스를 만들고 있다면, 이 사양을 채택할 것을 강력히 권장합니다.
This specification is identical to CommonMark for all input except Chinese, Japanese, Korean, and (some emojis and symbols). The aforementioned plugins/extension packages guarantee that their Markdown implementations output the same HTML for all CommonMark test cases as of CommonMark 0.31.2.
本仕様は、日本語・中国語・韓国語・ごく一部の絵文字や記号以外の入力に対してはCommonMarkと同一です。上記のプラグイン/拡張パッケージは、CommonMark 0.31.2時点の全てのCommonMarkテストケースでMarkdown実装が同じHTMLを出力することを保証しています。
除中文、日文、韩文和（少数表情符号和符号）之外的所有输入，本规范与CommonMark完全相同。上述插件/扩展包保证其Markdown实现在CommonMark 0.31.2的所有测试用例中输出相同的HTML。
본 사양은 한국어, 중국어, 일본어 및 (일부 이모티콘과 기호)를 제외한 모든 입력에 대해 CommonMark와 동일합니다. 앞서 언급된 플러그인/확장 패키지는 CommonMark 0.31.2 기준의 모든 CommonMark 테스트 케이스에서 동일한 HTML을 출력하는 Markdown 구현을 보장합니다.
This modification of the specification does not affect the other languages than Chinese, Japanese, and Korean. Even if your application or document has translations or content in other languages, it will not be affected, so please feel free to use the packages.
この仕様変更提案は、日本語・中国語・韓国語以外の言語には影響しません。アプリケーションやドキュメントに他言語の翻訳やコンテンツが含まれていても影響はありませんので、安心してパッケージをご利用ください。
除中文、日文和韩文外，建议的规范变更不会影响其他语言。请放心使用该软件包，因为如果您的应用程序或文档包含其他语言的翻译或内容，也不会受到影响。
이번 사양 변경 제안은 일본어, 중국어, 한국어 이외의 언어에는 영향을 미치지 않습니다. 애플리케이션이나 문서에 다른 언어의 번역이나 콘텐츠가 포함되어 있어도 영향을 받지 않으므로 안심하고 패키지를 사용하시기 바랍니다.
Please submit an issue or PR in English or Japanese. English is recommended.
Issue・PRは英語か日本語で投稿してください。英語を推奨します。
请用英语或日语提交问题或 PR。建议使用英语。
이슈나 PR은 영어 또는 일본어로 제출해 주시기 바랍니다. 영어를 권장합니다.
This repository adopts PNPM as a package manager.
To build all packages, run:
pnpm i
node --run buildTo run tests, run:
node --run test