RAKUS Developers Blog | ラクス エンジニアブログ

株式会社ラクスのITエンジニアによる技術ブログです。

【超入門】Markdown記法の使い方 (サンプル付き)

f:id:tech-rakus:20200623120651p:plain

はじめに

こんにちは。itoken1013です。
今回はMarkdown(マークダウン)の超入門として、利用度が高い記法10選を紹介します。
入社研修が終わって配属先の上司や先輩とコミュニケーションをとられている新入社員の方や、在宅勤務で以前よりもオンラインコミュニケーションの機会が増えた方には是非とも覚えていただきたい記法ばかりです。
皆様の日々のコミュニケーションにお役立てください!

そもそもMarkdown(マークダウン)とは何か

文章に見出しや箇条書きなど、文章に簡単に装飾を施すための記述法がMarkdown(マークダウン)です。
簡単な記述ルールに従って文章を作成するとHTMLへ変換され、装飾が施された文章が出来上がります。

例として以下はラクスのConnpassページでのイベントの紹介文ですが、ただの文字の羅列である上図よりも、Markdownによって装飾された下図の方が圧倒的に読みやすいことがお分かりいただけるかと思います。

ちなみにラクスでは社内のチャットツールにMattermostを採用していることもあり、
若手から部長までMarkdownを使ったコミュニケーションが毎日行われています。
エンジニア以外でも利用できる方は多いです。

Markdownが使えると何が便利か

コミュニケーションがスムーズ になる

上述のように文章に手軽に装飾を加えることができ、圧倒的に意見を伝えやすくなります。
日常のコミュニケーションの他、議事録やIssueでも読みやすい文章を作成することができるようになるでしょう。

ツールが変わっても使える

Markdownを採用しているツールやサービスは数多く(以下)、一度記法を覚えてさえしまえば、利用するツールが変わっても同様の記法で文章を作成することが可能です。
ちなみにこのブログもMarkdownで書いています。

  • GitHub
  • Qiita
  • 各種エディタ
  • Mattermost
  • Backlog ...etc

これだけ覚えれば安心な記法10選

それでは代表的な記法を紹介していきます。
ここで紹介する10個の記法を身につければ、普段のコミュニケーションに困ることは無くなるはずです。

1. 見出し

まずは見出し(例. 1章、第5節など)です。
見出しを表現するには 「 # + 半角スペース 」 の後、見出し名をつけることで表現できます。
また # を重ねることで、見出しの階層を表現することもできます。
議事録やアジェンダを示す際には、以下のような見出しがあると読みやすいですよね。

例として、以下では見出し4と5を組み合わせています。

  • 書き方例
#### オープニング
#### Meetupの発表内容
##### ①Twelve-Factor Appで読み解く、モダンなアプリの理想とレガシーなアプリの現実
##### ②開発グループが開発チームになるまでの歩み
##### ③結果整合性ができない開発者のドメインイベント活用例
  • 表示例

    オープニング

    Meetupの発表内容

    ①Twelve-Factor Appで読み解く、モダンなアプリの理想とレガシーなアプリの現実
    ②開発グループが開発チームになるまでの歩み
    ③結果整合性ができない開発者のドメインイベント活用例

2. 改行

次はシンプルですが、改行です。
改行は文末に半角スペース2つをつけることで実現できます。

  • 書き方例
文末に半角スペースを2つ付けると、改行できますよ→  
改行できました。
  • 表示例
    文末に半角スペースを2つ付けると、改行できますよ→
    改行できました。

3. リスト(箇条書き)

先頭にハイフンをつけることで、箇条書きを表現することができます。
また半角スペース2つでインデントをつけることで、階層構造を示すことできます。
ロジカルに考えを伝えたい場合など、多用するシーンが非常に多い記法です。

  • 書き方例
  - 好きな言語
    - Java
    - PHP
  - 好きなエディタ
    - VSCode
    - Vim
    - Typora
  - 好きなメディア
    - はてなブックマーク
    - Qiita

4. 番号付きリスト

先頭に番号をつけたリストを表示したい場合には、先頭に番号を付けて表現します。
また箇条書きと同様、インデントによって階層構造を示すことも可能です。

  • 書き方例
1. 住みたい町
    1. 鎌倉
    1. 神楽坂
    1. 荻窪
1. 部屋の条件
    1. 騒音
    1. ペット可
    1. 駅から徒歩3分
  • 表示例

    1. 住みたい町
      1. 鎌倉
      2. 神楽坂
      3. 荻窪
    2. 部屋の条件
      1. 騒音
      2. ペット可
      3. 駅から徒歩3分

5. 表(テーブル)

表は少し複雑ですが、 パイプ と ハイフン で作成できます。
またヘッダーと各行の間の1行にはハイフンを指定する必要がありますが、
ハイフンの左右にコロンを指定することで右寄せ、左寄せ、中央揃えを指定することができます。

  • 書き方例
|日付 | カテゴリー | イベントテーマ |
|---:| :---: | :--- |
|2020/6/17 | Meetup | SaaSを支える品質担保術|
|2020/6/19 | PHP | TechCafe|
|2020/6/24 | Meetup | SaaSを支える開発原則|
|2020/6/26 | オブジェクト指向 | オブジェクト指向LT会|
|右寄せ| 中央揃え | 左寄せ |
  • 表示例
日付 カテゴリー イベントテーマ
2020/6/17 Meetup SaaSを支える品質担保術
2020/6/19 PHP TechCafe
2020/6/24 Meetup SaaSを支える開発原則
2020/6/26 オブジェクト指向 オブジェクト指向LT会
右寄せ 中央揃え 左寄せ

6. 強調、太文字

文章の中で強調したい文言がある場合、文言の前後をアスタリスクで囲むことで表現できます。
一見して注目ポイントがアピールできるため、利用頻度が高い記法の一つです。
※ツールによってアスタリスクの個数が異なる場合があるため、各ツールのガイド等を確認ください。

  • 書き方例
7月もラクスの** Meetup **と** 勉強会 **が目白押しだよ!!
  • 表示例
    7月もラクスの Meetup 勉強会 が目白押しだよ!!

7. 取り消し線

取り消し線は文言の前後をチルダ(~~)で囲みます。
一度書いた文面に誤りや変更があった場合、私はよくこの取り消し線を使います。

  • 書き方例
アンケートの結果、先月は実に~~80%~~ 90% の方から高い満足度が得られました!
  • 表示例
    アンケートの結果、先月は実に80% 90% の方から高い満足度が得られました!

8. リンク

日々のコミュニケーションで、参照先のURLを紹介することは多いかと思います。
URLを貼り付けて示してもよいですが、分量が多くなってしまう場合、こちらのリンク記法が便利です。
リンクは 角カッコと丸カッコ を組み合わせて記述します。

  • 書き方例
ラクスのイベント情報は、[Connpass](https://rakus.connpass.com/)をチェックしてね!
  • 表示例
    ラクスのイベント情報は、Connpassをチェックしてね!

9. 引用

メールの返信で、複数の話題に触れる際には引用を使うことがあるかと思います。
Markdownでも引用をする際には、 > を使うことで表現をします。

  • 書き方例
> 次回の勉強会のテーマについて
オブジェクト指向です。

> イベント開催日
6/26(金)です。

> 場所
オンラインです。
https://rakus.connpass.com/event/178556/
  • 表示例

次回の勉強会のテーマについて

オブジェクト指向です。

イベント開催日

6/26(金)です。

場所

オンラインです。
https://rakus.connpass.com/event/178556/

10. 水平線

まとまった情報を示したり 文面にメリハリを加えることができます。
水平線は ハイフン3つ を挟むことで、簡単に記述できます。

  • 書き方例
ラクスのイベント情報を紹介したいと思います。
下記の内容をご確認ください。
---
- [【オンライン】SaaSを支える開発原則/DDD、心理的安全性、Twelve-Factor](https://rakus.connpass.com/event/178046/)
- [【オンライン】PHP::LT会 【LT枠@2:途中参加OK】](https://rakus.connpass.com/event/178724/)
- [【オンライン】オブジェクト指向LT会 vol.2(途中参加OK)](https://rakus.connpass.com/event/178556/)
---

たくさんの皆様のご参加、お待ちしています!   
  • 表示例

ラクスのイベント情報を紹介したいと思います。
下記の内容をご確認ください。



たくさんの皆様のご参加、お待ちしています!

終わりに

利用度が高いMarkdownの記法を紹介してきました。
まだまだ便利な記法はありますが、この10記法を覚えておけば、
十分にご自身が伝えたいことを読みやすく文章を起こすことができるはずです。
Markdownが使えるツールやサービスは日々増えていますので、このブログをご活用いただけましたら嬉しいです。
ではでは。

Copyright © RAKUS Co., Ltd. All rights reserved.