Markdownの書き方

• Markdownは記号とインデント(スペース4つかタブ1つ）で文章の構造を表現する。
• 段落の間は空行を入れます。

• 改行はタブまたはスペース4つ(環境依存)

• 見出し

  • 見出しは#の数で表現する

# 見出し1

## 見出し2

### 見出し3

#### 見出し4

##### 見出し5

###### 見出し6

表示

段落1

段落2

段落3

段落4

段落5

段落6

リスト

• リストは -,*,+のどれかとインデントで表現する。

例

- リスト1
    - リスト2 
        - リスト3
            - リスト4
                - リスト5
                    - リスト6
                        - リスト7

表示

• リスト1
  • リスト2
    • リスト3
      • リスト4
        • リスト5
          • リスト6
            • リスト7

数字リスト

• 数字を使ったリストを作成する場合は 数字.(ドット)と記載する。

例

1. リスト1
    2. リスト2 
        3. リスト3
            4. リスト4
                5. リスト5
                    6. リスト6
                        7. リスト7

表示

1. リスト1
   1. リスト2
      1. リスト3
         1. リスト4
            1. リスト5
               1. リスト6
                  1. リスト7

＃ チェックボックス

• 課題管理ツールなどで便利なチェックボックスの記述。backlogなどで使うとチェックボックスをチェックした時にチケット更新されます。

例

• [x] Foo
• [ ] Bar
• [ ] Baz

表示

• [x] Foo
• [ ] Bar
• [ ] Baz

コード

• プログラムコード、htmlなどはMarkdown記法と競合してしまう場合があるので ```バッククオート三つで囲んで表現する。

例

    def main():
        print("Hello World")

    if __name__ == '__main__':
        main()

表示

def main():
    print("Hello World")

if __name__ == '__main__':
    main()

• gitlabやqiitaなどの場合```の後ろに言語名をつけるとsyntax highlightされます。

    def main():
        print("Hello World")
  
    if __name__ == '__main__':
        main()
  

引用

• 文字列の引用表示をすることができます。
• 引用表示したい列の前に>を書きます。

例

> ここが引用表示です。
> 二行目

表示

ここが引用表示です。
二行目

強調

• 文字列を強調して表示することができます。
• ボールド ** ** アスタリスク二つで囲む

例

**ボールド**

表示

ボールド

• コード ` ` バッククオートで囲む

例

`コード`

表示

コード

• イタリック _ _ アンダースコアで囲む

例

_イタリック_

表示

イタリック

表

• セル

  • セルは縦線 | (バーティカルバー)を文字列で囲んで表現

• 揃え

  • - と:(コロン)で表現する。
    • 左寄せ
      • :--
    • 右寄せ
      • -:
    • 中央寄せ
      • :-:
  • 最低三文字で文章の見栄えによってハイフンの数は自由。

例

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       | This        | This         |
| column     | column      | column       |
| will       | will        | will         |
| be         | be          | be           |
| left       | right       | center       |
| aligned    | aligned     | aligned      |

表示

画像埋め込み

例


表示

リンク

例

[リンクテキスト](リンクURL)

表示

ゆめみホームページ

注釈

例

• 注釈入れたい文言[^1]

注釈

[^1]: 注釈

表示

• 注釈入れたい文言¹

注釈