Markdown 記法 チートシート

Markdownは、テキストベースのマークアップ言語の一種で、その簡易さと読みやすさが広く評価されています。特に、ウェブ上でのコンテンツの書き方や、その他さまざまな文書作成に使用されています。Markdownの主な特徴や利点・マークダウン記法のチートシートを自分の備忘録としてまとめてみました。

マークダウンとは?

• マークダウン記法は、テキストを構造化して記述する「マークアップ言語」の 1 つです。
• 特定の記号を使用して段落、見出し、装飾などを自動的に表示できます。
• 装飾された HTML ドキュメントに変換できる軽量のマークアップ言語

マークダウンの特徴

1. シンプルさとアクセシビリティ:
   • Markdownは、簡単に覚えることができ、誰でも使い始めることができます。特別なトレーニングや深い技術知識は必要ありません。
2. 可読性:
   • プレーンテキストで書かれているため、マークアップが最小限に留まり、テキストは非常に読みやすいです。これは、コードやテキストの混在する文書でもその文脈が明確であることを意味します。
3. プラットフォーム独立:
   • Markdownファイルはプレーンテキストであるため、どのようなデバイスやオペレーティングシステムでも開くことができます。
4. 変換の容易さ:
   • MarkdownはHTMLに直接変換される設計になっており、ウェブ上での使用が非常に簡単です。さらに、多くのツールがPDF、Word、など他のフォーマットへの変換もサポートしています。
5. バージョン管理の互換性:
   • プレーンテキストであるため、MarkdownファイルはGitなどのバージョン管理システムと非常に相性が良いです。これにより、変更の追跡やコラボレーションが容易になります。
6. 集中的な執筆環境:
   • 複雑なマークアップや埋め込みコードを気にすることなく、コンテンツの作成に集中できます。これはブロガーや作家、技術文書作成者にとって特に有益です。
7. 拡張性:
   • いくつかのバージョンのMarkdownは、表やフットノート、埋め込みコードなどの追加要素をサポートしており、基本的なMarkdownにはない機能を提供します。

ただし、Markdownには制限もあり、非常に複雑な書式や高度なレイアウトを必要とする文書には適していない場合があります。それでも、そのシンプルさと柔軟性のため、多くのプロジェクトやコミュニティで広く採用されています。

Markdownチートシート

見出し

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

強調（太字）

**太字**

イタリック（斜体）

*イタリック*

引用

> 引用文

リスト

* 項目1
* 項目2
  * サブ項目2-1
  * サブ項目2-2

番号付きリスト

1. 項目1
2. 項目2
3. 項目3
   1. サブ項目3-1
   2. サブ項目3-2

コードのインライン表示

`code`

コードブロック
（参考：コードは「“`」で挟むことでブロックとして挿入でき、以下のように言語を指定するとコードへ装飾（シンタックスハイライト）が適用されます。）

```js

```

区切り線

---

リンクの挿入

[title](https://www.example.com)

画像の挿入

![alt text](./image.jpg)

フェンスで囲まれたコードブロック

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

テーブル　表

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

これらはMarkdownの基本的な文法ですが、使っているエディターやプラットフォームによっては、これらの標準規則からいくらか変更されている場合があります。また、拡張MarkdownやGitHub Flavored Markdown（GFM）のようなさまざまな派生形が存在し、追加機能や異なる構文が用意されていることもあります。

拡張Markdownの追加機能の例

| 左寄せ | 中央寄せ | 右寄せ |
| :---   | :---:    | ---:   |
| cell1  | cell2    | cell3  |
| cell4  | cell5    | cell6  |

これはフットノートの例です。[^1]

[^1]: ここがフットノートのテキストです。

用語
: 定義

用語2
: 定義2

~~取り消されたテキスト~~

- [x] タスク1
- [ ] タスク2
- [ ] タスク3

GitHub Flavored Markdownの例

```python
def function():
    # コメント
    print("Hello, world!")
```

http://www.example.com

~~取り消し線~~

- [x] タスク1
- [ ] タスク2
- [ ] タスク3

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

@username

:emoji_code:

これらの機能は、Markdownの利便性を大幅に向上させ、特にGitHubなどのプラットフォームでのコード共有やコラボレーションにおいて有用です。それぞれの機能がどの環境やエディターでサポートされているかは、使用している具体的なシステムや設定によって異なる場合があります。

Useful Link

• Markdown Cheat Sheet on Markdown Guide
• Markdown Crash Course Traversy Media in Youtube