マークダウン記法をする時に気をつけていること

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る

はじめに

マークダウン記法を使うことで、文章上や構成の面で様々な表現が可能になります。

GitHubでの共有やQiitaをはじめ、マークダウン記法は様々な場所で使うことができる記法で、文章の構成を俯瞰するためにも有用といえます。

今回は、自分自身がマークダウン記法を使う際に気をつけていることをご紹介したいと思います。

見出しを使い過ぎない

見出しは全部で6種類あります。

有効に使うことができれば記事全体の構成を掴むためにとても有効な手段となるのですが、使いすぎると、逆に読みにくくなってしまうことがあります。

見出しが多いと、どうしても小さい見出しになればなるほど内容が薄れていきます。

具体例の提示や、並列的な情報を1つの見出しで書きたい場合は、1つ下の見出しを使った方がわかりやすくなることがあるのですが、そうでない場合は、基本的に見出しは3階層(見出し1~3)くらいに抑えておくのが良いと思います。

装飾表現は、目的にあった使い方をする

マークダウン記法には、文章自体を装飾する表現として、「太字」「斜体」「太字+斜体」「インライン表記」など様々ありますが、それぞれの使用目的は、同一記事内で統一した方が良いと思います。

こうすることで、読者が見出しの重要な部分を瞬時に判別することができ、結果的に大事なところを正確に伝えることができると考えています。

どんな表現であれ、使用方法や目的が統一されていれば問題はないと思います。

1見出し1装飾

先ほどの見出し乱用の問題とも被る部分があるのですが、1つの見出しにつき、最低1つの装飾文を入れてあげることで、その見出しのアイデンティティが確立されるため、おすすめの記法となります。

逆に見出しの中の文章のほとんどが装飾表現になってしまうような場合は、読者に正確に重要な点が伝わらなくなってしまう可能性があるため、見出しを分割することをおすすめします。

おわりに

簡単ではありますが、自分自身がマークダウン記法を使用する際に気をつけていることを書いてみました。

用法容量を考えて、素敵なマークダウンライフをお送りください!

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
     

コメントを残す

*