マークダウン記法のまとめ〜Gitでマークダウン式でメモをとりたい〜

この記事は約5分で読めます。

基本的なマークダウンの記法をメモしていきます。

マークダウンは、普段のメモ書きから技術ドキュメントの作成まで、エンジニアにとって必須のスキルです。シンプルで覚えやすいので、ぜひマスターしたいところです。


見出し (Headings)

見出しは行頭に#(シャープ)を付けることで表現します。#の数が見出しのレベルに対応しており、HTMLの<h1>から<h6>に相当します。

Markdown

# 見出し1 (h1)
## 見出し2 (h2)
### 見出し3 (h3)
#### 見出し4 (h4)
##### 見出し5 (h5)
###### 見出し6 (h6)

💡ポイント: #と見出し文字の間には半角スペースを入れましょう。


文字の装飾 (Emphasis)

文字を強調するための記法です。

  • 太字 (Bold): **または__で文字を囲みます。
    Markdown

    **これは太字です**
    __これも太-字です__
    
  • 斜体 (Italic): *または_で文字を囲みます。
    Markdown

    *これは斜体です*
    _これも斜体です_
    
  • 打ち消し線 (Strikethrough): ~~で文字を囲みます。
    Markdown

    ~~打ち消し線~~
    

リスト (Lists)

箇条書きリストには、「順序なしリスト」と「順序付きリスト」の2種類があります。

  • 順序なしリスト (Unordered List): 行頭に-(ハイフン)、*(アスタリスク)、+(プラス)のいずれかを付けます。

    Markdown

    - りんご
    - ごりら
      - らっぱ
    - ぱせり
    

    💡ポイント: インデント(半角スペース2つまたは4つ)を付けることで、リストを階層化できます。

  • 順序付きリスト (Ordered List): 行頭に数字.(数字とピリオド)を付けます。数字は自動で連番になります。

    Markdown

    1. 最初にこれをやる
    2. 次にこれをやる
    3. 最後にこれをやる
    

引用 (Blockquotes)

他人の文章やコメントを引用する際に使用します。行頭に>(大なり)を付けます。

Markdown

> これは引用です。
> 引用は複数行にまたがって書くこともできます。
>
> > さらにネスト(入れ子)することも可能です。

コードの表示 (Code)

  • インラインコード (Inline Code): 文中に短いコードを埋め込む場合は、コードを`(バッククォート)で囲みます。

    Markdown

    `const greeting = "Hello, World!";` のように書きます。
    
  • コードブロック (Code Blocks): 複数行のコードを記述する場合は、コード全体を```(バッククォート3つ)で囲みます。

    Markdown

    ```javascript
    function greet(name) {
      console.log(`Hello, ${name}!`);
    }
    
    greet("Engineer");
    

    💡ポイント: 最初の```の直後にプログラミング言語名(例:javascript, python, ruby)を指定すると、コードが色付けされて見やすくなります(シンタックスハイライト)。


リンク (Links)

Webページなどへのリンクを設置します。

Markdown

[表示するテキスト](URL)

記述例:

Markdown

[Google](https://www.google.com)

画像 (Images)

画像を表示します。基本的な書き方はリンクと似ていますが、先頭に!(エクスクラメーションマーク)が付きます。

Markdown

![代替テキスト](画像のURL)

代替テキストは、画像が表示されない場合に代わりに表示される文章です。

記述例:

Markdown

![GitHubのロゴ](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)

表 (Tables)

表(テーブル)を作成することもできます。少し複雑に見えますが、構造は単純です。

  • |(パイプ)で列を区切ります。
  • ---でヘッダー行とデータ行を区切ります。
  • :(コロン)を使って、列の文字寄せ(左寄せ、中央寄せ、右寄せ)を指定できます。

記述例:

Markdown

| 左寄せ | 中央寄せ | 右寄せ |
| :--- | :---: | ---: |
| item 1 | item 2 | item 3 |
| item 4 | item 5 | item 6 |

表示結果:

左寄せ 中央寄せ 右寄せ
item 1 item 2 item 3
item 4 item 5 item 6

水平線 (Horizontal Rules)

話の区切りなど、文章を視覚的に分割したい場合に使用します。---(ハイフン3つ)、***(アスタリスク3つ)、___(アンダースコア3つ)のいずれかを単独で記述します。

Markdown

これは最初の段落です。

---

これは次の段落です。

これらの基本的な記法を覚えれば、GitHubのREADMEやプルリクエスト、社内のドキュメント作成など、様々な場面でスムーズに情報を整理し、共有できるようになります!

タイトルとURLをコピーしました