Markdownは見た目より先に文章の構造を整える

Markdownは元のファイルをテキストとして読めるため、メモや文書作成に便利です。記号を増やすのではなく、見出し、段落、リストの役割を分けることに意味があります。

見出しは文字の大きさだけではない

文書の主題を最上位に置き、その下に各節を配置します。半角スペースが続く#と##は異なる階層です。すべての行を最上位の見出しにすると構造が失われます。

独立した項目にはリスト、項目間の関係を説明するなら段落を使います。書式は分かりやすい文章を支えるもので、その代わりにはなりません。

参考資料: CommonMark 0.31.2 — Structured text, headings and rendering differences

プレビューはすべての公開環境を再現しない

Markdownの拡張機能はシステムごとに違います。あるエディターで表が表示できても、別の環境で同じになるとは限りません。実際に読まれる場所で確認します。

ToolRoofはHTMLをプレビュー・出力しますが、入力した生のHTMLは実行しません。外部画像は説明に置き換わり、プレビュー内のリンクは無効です。Webページ全体の再現ツールではありません。

参考資料: CommonMark 0.31.2 — Structured text, headings and rendering differences

表示用のコピーと元ファイルを残す

Markdownのソースは後の変更比較に便利です。HTMLは表示に使えますが、逆変換で元の書き方まで完全に戻るとは限りません。

共有前に内容とリンクを見直してください。プレビューは情報の正しさやリンク先の安全性を証明せず、他人の素材の利用権も与えません。

例:短い会議メモ

# 今週の計画、続けて## 優先事項を書き、別々の行に- 要約を確認と- 下書きを送るを置きます。4つの似た段落ではなく、主見出し、節見出し、2項目のリストになります。

#今週の計画のようにスペースがないとATX見出しにはなりません。バッククォートで囲んだコードは表示用のテキストです。表示されたことは実行や正しさの証明を意味しません。

参考資料