Markdown のよくあるミス：再現して直し、出力を確認する
見出し、タスクリスト、リンクのミスを、同じチェックリストの修正前後で確認します。空白と括弧から原因を絞り、インデントやフェンス、レンダラーの違いも点検。プレビューと出力画像を比べ、編集できる原稿とリンクを残します。
Markdown は書き間違えても表示されることが多く、意図とは違う構造になるだけの場合があります。Markdown コンバーターでプレビューしながら原因を絞り込みましょう。最小限の例を先に直し、その修正を文書全体に反映します。
次のチェックリストは、意図的に誤った書き方にしています。見出しの空白がなく、リスト記号とチェックボックスがつながり、リンク先の丸括弧が抜けています。
#Export check
**Status:** Ready for review
-[x] Heading checked
-[x] List spacing checked
-[ ] Final export inspected
[Open the converter]https://markdowntoimage.com/converter
構造になるはずの場所に記号がそのまま出ていないか確認します。テーマを変えても構文のミスは直りません。実際の公開作業とは無関係なサンプルなので、自由に編集できます。
- 見出し記号の後に空白を入れ、
#Exportを# Exportにします。先頭行が見出しとして解釈されるようになります。 - リスト記号とチェックボックスを分け、
-[x]を- [x]にします。チェックボックスとラベルの間にも空白が必要です。タスクリストは GFM の拡張機能なので、レンダラーの対応が必要です。 - リンク先を丸括弧で囲み、
[label](URL)とします。角括弧は表示する文字、丸括弧はリンク先です。画像内の色ではなく、レンダリングした文書でリンクを開いて確認してください。
修正済みの入力全体と、その書き出し結果です。
# Export check
**Status:** Ready for review
- [x] Heading checked
- [x] List spacing checked
- [ ] Final export inspected
[Open the converter](https://markdowntoimage.com/converter)
見出し、状態、タスクが区別できるようになりました。最後のタスクは意図的に未完了のままです。プレビューが整っていても、出力の点検が終わったとは限りません。
あるエディターで使える拡張が、別のエディターでも使えるとは限りません。基本構文は CommonMark 仕様、表やタスクリストなどの拡張は GFM 仕様を参照できます。比較できるよう、問題の断片を小さく保ちます。
入れ子の項目が親リストから外れたら、文書全体に空白を足すのではなく、その項目のインデントを調べます。通常の文章が突然コードになったら、前方に閉じ忘れたフェンスがないか探してください。記号をそのまま見せたい時は、インラインコードや適切なエスケープを使います。
プレビューが意図した構造になってから書き出します。ダウンロードした画像を開き、先頭の見出し、各タスクのラベル、最終行を読み直してください。操作用のリンクは画像に添える本文にも書きます。画像はピクセルなので、Markdown のリンクはクリックできません。次の修正に備えて、編集可能な原稿を保存しましょう。
チェックリストを直して書き出す。基本構文は Markdown 実用ガイド、フェンスやハイライトの問題はコードブロックのガイドへ進んでください。