Markdown記法について

はじめに

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90％、年休124日以上 etc.　　詳細はこちらから＞

mdファイルについてファイルの内容を読むばかりでしたので、改めてMarkdown記法について調べなおしてみました。
（よくあるのはREADME.mdなど）

そもそもMarkdownとは？

マークダウンとは、マークアップ言語と言われるテキストの書き方の一種です。タグを使用して文字の見出しや強調など文章の記法ができるHTMLはWebページに使われる記法になります。
また、タグといえばXMLもデータ構造を記述できるマークアップ言語のひとつです。

Markdownの良さって？

今まで書く機会がなかったため、メリットについてあまり理解できておりませんでした。
ですが、簡単に文字強調や見出しが設定でき、環境構築のためのナレッジの溜め込み、手順書作成など、文章を見やすくすることができることに気が付きました。
覚えてしまえばかなり便利な記法です。 

Markdown記法のルールを見てみましたが、見てるだけじゃ覚えられない、ということで実際にmdファイルを作成して覚えていきたいと思います。

VS CodeでMarkdown記法を試してみた

VS Codeで新規ファイル作成し、ファイル名をtest.mdとしました。
まずはお試しで見出しを記載し、プレビューを確認しました。
当たり前ですが、ちゃんと#の個数で見出しの大きさが変わってました。

ちなみに、プレビューは右上の虫眼鏡ボタンで見れます。

その他も試してみます。
と思って文章を書いたのですが、最初から躓きました。
文章が改行されません。

実はこれ、半角スペース2つ入れると改行されました。

（慣れれば訳ないかもしれないですが、超初心者は焦りました。）
色々書いてみました。

コツをつかめば簡単に書けそうです。
同じチームの方はマークダウン楽だよ、と言っていた理由が少しだけわかりました。
一部HTMLの<br>タグを使ったりなど、マークアップ言語なんだなと実感しました。

今回自分が書いてみたサンプルを記載しておきます。

最後に

今回はMarkdown記法について、紹介いたしました。
手順書やナレッジをチーム内に展開するときに便利そうなので、たくさん調べて活用していきたいと思います。

【エンジニア募集中】フルリモートも◎(リモート率85.7％)、平均残業8時間、年休124日以上、有給取得率90％ etc.　詳細はこちらから＞