Markdown チートシート - 最も役立つ構造とフォーマット
Markdownでサポートされているコマンドの役に立つリマインダー
Markdown 言語は、ウィキペディアや Hugo で使用されています。 見出し、リスト、フォントスタイルの変更、画像、コード引用、およびテーブルをサポートしています。 ここでは、Markdown のフォーマットの簡単な概要をまとめています。
上記の画像は、Flux - text to image AI によって作成されました。
Markdown は、プレインテキストのドキュメントに書式を追加するために使用できる、軽量 なマーカップ言語です。このガイドでは、最もよく使用される Markdown 構文 の包括的な概要を提供し、見やすく構造化されたドキュメントを作成するのに役立ちます。
見出し
Markdown では、ハッシュ記号 (#) を使用して見出しを作成します。見出しの前に配置されるハッシュの数は、見出しのレベルを示します。
# H1
## H2
### H3
#### H4
##### H5
###### H6
強調
Markdown では、いくつかの方法でテキストを強調できます。イタリック体にはアスタリスク (*) やアンダースコア (_) を、太字にはダブルアスタリスク (**) やダブルアンダースコア (__) を使用します。
イタリック
*イタリック* もしくは _イタリック_
太字
**太字** もしくは __太字__
太字とイタリック
***太字とイタリック*** もしくは ___太字とイタリック___
リスト
Markdown は順序付きリストと順序なしリストの両方をサポートしています。
順序なしリスト
- アイテム 1
- アイテム 2
- サブアイテム 1
- サブアイテム 2
順序付きリスト
1. 最初の項目
2. 2番目の項目
1. サブアイテム 1
2. サブアイテム 2
リンク
リンクを作成するには、リンクテキストを角括弧 ([]) で囲み、URL を丸括弧 (()) で囲います。
[リンクテキスト](URL)
例
詳しくは [Markdown ガイド](https://www.markdownguide.org/) を参照してください。
画像
画像を追加するには、エクスクラメーションマーク (!) を使用し、画像の代替テキストを角括弧で囲み、画像の URL を丸括弧で囲います。
例
引用
引用は、大なり記号 (>) を使用して作成します。
> これは引用です。
ネストされた引用
> これは最初のレベルの引用です。
>> これはネストされた引用です。
インラインコードとコードブロック
インラインコードはバッククォート (` ) で囲み、コードブロックはトリプルバッククォート (``` ) を使用します。
インラインコード
C 言語でテキストを出力するには `printf()` を使用します。
コードブロック
```python
def hello_world(): print("Hello, World!")
```
コードブロックについてもっと詳しく知りたい場合は、別の投稿をご覧ください: Markdown コードブロックの使用
水平線
水平線は、3つ以上のダッシュ (—)、アスタリスク (***)、またはアンダースコア (___) を使用して作成します。
---
テーブル
Markdown では、パイプ (|) とハイフン (-) を使用してテーブルを作成します。
例
| ヘッダー 1 | ヘッダー 2 |
|----------|----------|
| セル 1 | セル 2 |
| セル 3 | セル 4 |
タスクリスト
タスクリストは、チェックボックスを作成できる特殊なリストです。
例
- [x] 完了したタスク
- [ ] 未完了のタスク
赤字
赤字は、ダブルチルダ (~~) を使用して作成します。
~~これは赤字のテキストです。~~
ハイライト
ハイライトは、Markdown ではネイティブにはサポートされていませんが、一部のレンダラーでは == 構文を使用してサポートされています。
例
==これはハイライトされたテキストです。==
下付き文字と上付き文字
下付き文字は、テキストの前にキャレット (^) を使用し、上付き文字は、テキストの前にチルダ (~) を使用します。
例
H~2~O は水です。
E = mc^2
数式
数式は、ドル記号 ($ ) 内で LaTeX 構文を使用して追加できます。
例
$$ E = mc^2 $$
特殊文字のエスケープ
特殊文字をエスケープするには、バックスラッシュ () を使用します。
例
\*イタリック\* もしくは \_イタリック\_
この包括的なチェックシートは、見やすくフォーマットされたドキュメントを作成するために必要な基本的な Markdown 構文をカバーしています。より高度な機能やカスタマイズについては、特定のレンダラードキュメントや追加リソースを参照してください。
