Markdown

Markdown はマークアップ言語のひとつで、文書作成に使われます。代表的なマークアップ言語の HTML ではソースコードと最終的な見え方が大きく異なりますが、Markdown は元の記述のままでも「それなりに見える・読める」ので覚えてしまえば簡単に使えます。

GitHub のリポジトリに説明を表示するには Markdown で記述して README.md というファイル名で置いておくのが定石です。GitHub を使う人は基本的な書き方を知っておいたほうが良いでしょう。

VSCode で Markdown を記述する

Markdown でドキュメントを作成するには、ソースコードと最終的な見え方を同時に表示してくれるようなエディタがあると便利です。メジャーなエディタで Markdown に対応しているものがいくつかあり、VSCode（Visual Studio Code）はそのひとつです。”両開きページに虫メガネ” のアイコンを押すと右側に最終的な見え方が表示されますので、それを参照しながら左半分で編集することができます。

上の例では見出し、改行（段落）、文字修飾の機能を使ってますが、他にもいろいろな機能があるので自分なりに使いやすい解説ページを見つけてブックマークしておくと良いでしょう。