Markdown 除去ツールが捨てるもの、そしてそれを残す方法

「Markdown を取り除く」は一つの操作のように聞こえます。実際には小さな判断の連続であり、変換ツ ールは認めるかどうかにかかわらず、そのすべてをあなたの代わりに下しています。

たいてい下手に判断されるのが、次のものです。

リストの番号

もっとも影響が大きいものです。よく使われるライブラリーはリストを書式の構造とみなして平坦化 し、箇条書きの記号と一緒に 1. 2. 3. を取り除きます。

箇条書きなら、それも一理あるかもしれません。番号付きリストでは意味を壊します。番号は何かを指 していたのです。番号付きの設問への回答、手順の並び、順位のついた項目 — すべてが順序のない山に なります。

ここでは番号を残します。7 から始まるリストも、別のリストの中に入れ子になった番号付きリストも 含めてです。

リンクの背後にある URL

[ドキュメント](https://example.com/guide) には二つの情報があります。プレーンテキストには二つ 目を置く場所がないので、変換ツールはそれを書き出すか捨てるかしかありません。

捨てるのは静かで、よくあることです。読み手は「ドキュメント」だけを受け取り、そこへ行く手段を 失います。ここでの既定は両方を書き出します — ドキュメント (https://example.com/guide) — リン クをたどれない読み手は何かを失っているからです。リンクが重要でないと分かっているときのため に、テキストのみ、URL のみも用意しています。

コードブロックの言語

```java と印の付いたブロックは事実を運んでいます。これは Java だ、という事実です。印 を取り除けばその事実も一緒に去り、何であってもおかしくない、説明のない記号の塊が残ります。

言語はラベルとして出力されます — [java] — 読み手が分かるようにです。お好みで、オフにすること も、元の印のまま残すこともできます。

画像の代替テキスト

画像は画像のままでは生き残れません。しかしその代替テキストは、誰かがそれを説明するために書い た一文であり、多くの場合それが文書内でその内容を説明する唯一のものです。画像を捨てて説明を残 す方が、両方を捨てるよりたいてい良い判断です。

脚注、引用、区切り線、フロントマター

どれも、除去ツールが黙って取り除きうる内容です。ここではどれも既定で残り、個別に切り替えられ ます。

なぜ無損失が正しい既定なのか

これらの多くを決着させる試金石はこうです。入力を見たことのない読み手が、出力だけを読んで、 そこに書かれていたすべてを理解できるか。

答えが「いいえ」なら、その変換ツールは読み手のために、尋ねもせずに情報を捨てたということで す。自分で消さなければならないものを残す変換ツールは、十秒だけ煩わしい。必要だったものを消す 変換ツールは、それが問題になるまで気づかないかもしれない問題です。

ですから既定はすべてを残し、取り除くことはすべてあなたが選ぶスイッチになっています。一つのプ リセット — 報告書と表 — だけは意図的にその規則を破り、コードブロックと画像を取り除きます。 迷い込んだ断片がノイズになる報告書に、比較表を持ち上げるために存在するからです。それは例外で あり、そう明記してあり、既定プリセットは何も取り除きません。

本当に答えのないもの

いくつかの判断には正しい既定がなく、文脈があるだけです。

• 見出しにする手段が何もないとき、見出しはどう見えるか。素のまま、大文字、あるいは # を残 す。
• 表がないとき、表はどう見えるか。桁の揃った列、タブ、あるいはラベルと値。
• タスクリストはどう見えるか。[ ]、☐、あるいは何も付けない。

プリセットがあるのはこのためです。一つを選んで普遍的だと称するのではなく、各プリセットが特定 の送り先 — メールソフト、表計算、チャットの画面、ドキュメントのページ、ウェブフォーム — に対し てこれらすべてに答え、しかも見本を見せます。答えを信用する前に、それを確かめられるようにです。