Markdown cheatsheat

共通項目

• Markdownは記号とインデント(スペース4つかタブ1つ）で文章の構造を表現する。
• 段落の間は空行を入れます。
• 改行はタブまたはスペース4つ(環境によって異なる時もあります)
• Markdownで使われる記号をエスケープする時は(バックスラッシュ)を記号の前に書く

見出し

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

# 見出し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
   2. リスト2
      3. リスト3
         4. リスト4
            5. リスト5
               6. リスト6
                  7. リスト7

コード

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

例

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

表示

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

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

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

コードの補足

• バッククオート使った文字列をさらにコードで表示したい場合は囲んだバッククオートよりも大きい数でバッククオートで囲むと表示できます。
• 例

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

• 表示

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

引用

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

例

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

表示

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

文字修飾

リンク

• 例

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

表示

ゆめみホームページ

画像埋め込み

• 例


• 表示例の記載


• 表示

画像埋め込み(参照型)

• urlを別の箇所にまとめて記載して参照させて表示させることもできます。

• 例

![代替テキスト][外部参照の名前]
[参照名]: url

• 表示例の記載

![CTO][freeCTO]

[freeCTO]: https://yutachaos.gitbooks.io/markdown/content/assets/free_cto.jpg

• 表示