Markdown 互換性テスト：実用的な .md テストパック

GitHub でテストパックを入手

ドキュメントと画像ファイルをまとめて取得するには、Code → Download ZIP を選びます。リポジトリでは、ダウンロード前にソースを確認したり、変更履歴を見たりすることもできます。

このパックは CC BY 4.0 のオープンライセンスで公開しています。クレジットを表示すれば、テスト素材を再利用・改変できます。ただし、Markdific アプリがオープンソースになるわけではありません。

要点：ZIP をダウンロードし、同じ .md ファイルを各ツールで開いて、正しくレンダリングされたものを記録します。そのうえで作業用コピーを保存し、書き出します。レンダリング、Markdown のラウンドトリップ、書き出した形式は、それぞれ別の結果として記録してください。

テストの対象

バージョン 1.0 のドキュメントには、番号付きのセクションが 30 あります。各セクションには、CommonMark、GitHub Flavored Markdown（GFM）、一般的な拡張構文、アプリ固有の構文、HTML の扱い、ラウンドトリップのどれをテストするかが明記されています。

数式、Mermaid、Obsidian の構文は、CommonMark の中核仕様には含まれません。これらに対応していないレンダラーでも、CommonMark には正しく準拠している場合があります。このパックは実用的な比較用ドキュメントであり、標準への準拠を正式に検証するテストスイートではありません。

公平に比較する方法

1. リポジトリの ZIP をダウンロードします。.md ドキュメントと assets/ を切り離さずに展開してください。
2. 手を加えない基準用のコピーを 1 つ残しておきます。アプリのバージョン、OS、レンダラーのモード、テスト日を記録します。
3. 1 つ目のツールで作業用コピーを開きます。レンダリング結果と、可能であればソースを確認します。
4. 小さな編集を 1 つ加えて Markdown として保存し、保存したファイルを基準のコピーと比べます。
5. HTML、PDF、DOCX など、そのツールが対応している各形式に書き出します。書き出したファイルを開き、個別に確認します。
6. 同じ基準のコピーを使って、ほかのツールでも繰り返します。ドキュメント内の結果表を埋めます。

すべての観察結果を「Markdown 対応」という 1 つの評価にまとめないでください。図をレンダリングできても編集はできないビューアーもあります。PDF では見た目を保てても、Mermaid のソースは失われる変換ツールもあります。これらは別々の結果です。

結果の区分

• 合格：テストした操作の後も、構造と意味が保たれている。
• 一部合格：内容は使えるが、書式、ソース、メタデータ、編集の可否のいずれかが変わる。
• 非対応：オプションの拡張構文が実装されていないが、ソースは復元できる。
• 不合格：内容が消える、誤解を招く表示になる、安全でない内容が実行される、または復元できない。
• 未テスト：操作を完了できなかった、または該当しない。

各区分の根拠も記録してください。たとえば「Mermaid が読みやすいコードブロックとして表示された」場合、そのツールが Mermaid のレンダリングをうたっていない限り、通常は不合格ではなく非対応です。

画像テスト：読み込まれるべきものと、読み込まれないもの

ZIP には、正しく表示されるローカル画像のテスト素材が 6 つ含まれています。PNG、JPEG、WebP、スペースを含むファイル名、HTML で参照する画像、Obsidian 形式で貼り付けた画像です。assets/ はドキュメントと同じ場所に置いてください。6 つのファイルはあえて同じシンプルな絵柄にしているので、見た目の違いに左右されず、ファイル形式とパスの扱いだけを比較できます。

ほかの 2 つのパスは、単体のパッケージではあえて解決できないようにしています。親フォルダーからの相対パスはより大きなフォルダー構成を、サイトルートからの相対パスは Web サイトを前提としています。リモート画像はネットワーク接続を必要とします。これらは、見つからない素材や外部の素材をツールがどう伝えるかをテストするもので、ZIP からファイルが欠けているわけではありません。

同梱のローカル画像がすべて表示されない場合は、レンダラーを評価する前に、展開の状態、フォルダーの配置、ローカルファイルへのアクセス権限を確認してください。

保存と書き出しの後に確認すること

見た目のプレビューでは、ソースの変化に気づかないことがあります。保存した Markdown で、リンク先の欠落、書き換えられた画像パス、崩れた表、変更されたコードフェンス、エスケープされた文字、削除されたメタデータがないかを確認してください。意味に影響しない書式の正規化と、意味が失われることは区別して考えます。

PDF では、改ページ、コードの折り返し、数式、図の解像度、リンクを確認します。DOCX では、見出し、表、リスト、画像が編集できる状態で残っているかを確認します。HTML では、構造、ローカルの素材、HTML がそのまま書かれた部分の安全な扱いを確認します。

ドキュメントには無害なスクリプトのテストが含まれています。安全なプレビューでは、スクリプトを実行せずにエスケープしたり、削除したり、ソースとして表示したりすることがあります。スクリプトの実行がブロックされても、不合格とはみなさないでください。

再現できる形で結果を共有する

比較結果を公開するときは、パックのバージョン（1.0）、ツールとそのバージョン、OS、設定、読み込み方法、書き出し設定、記入済みの結果表、意味のある違いのスクリーンショットを含めてください。テストファイルに変更を加えた場合は、その旨を明記してください。

このパックは Markdific が作成したもので、Markdific 自体がテスト対象のアプリに含まれることもあります。すべてのアプリに同じファイルと同じ評価基準を適用してください。ある製品が実装しているというだけで、オプション機能がないことをほかの製品の欠陥とみなさないでください。

ダウンロードと再利用

GitHub で Markdown 互換性テストパックを開く

Code → Download ZIP を使うと、.md ドキュメント、assets/、README、ライセンスをまとめて取得できます。

ドキュメントと同梱の画像素材は CC BY 4.0 でライセンスされています。利用する際は「Markdific Markdown Compatibility Test Pack v1.0」のクレジットを表示し、リポジトリとライセンスへのリンクを付けてください。素材を改変した場合は、変更点も明記してください。

よくある質問

これは CommonMark の公式テストスイートですか？

いいえ。CommonMark には独自の仕様と準拠確認用の例があります。このパックは、拡張構文や書き出しを含め、実際のドキュメントとワークフローをテストするものです。

静的サイトジェネレーターもテストできますか？

はい。エンジン、プラグイン、設定、テーマ、ビルドのバージョン、素材のパスのルールを記録してください。開発用のプレビューだけでなく、生成された HTML とファイルを比較します。

テストパックを公開したり改変したりできますか？

はい、CC BY 4.0 の条件のもとで可能です。クレジットを表示し、ライセンスへのリンクを付け、変更点を示してください。何をテストしたかが読者にわかるよう、比較結果には元のバージョン表記を残してください。

参考資料

• CommonMark 0.31.2 仕様
• GitHub Flavored Markdown 仕様
• Mermaid ドキュメント
• Obsidian の Markdown 構文
• クリエイティブ・コモンズ 表示 4.0