この記事で解決すること
「README.mdって何?」「Markdownってどう書くの?」
GitHubやブログでよく使われるMarkdownの書き方を、よく使うものだけ10個に絞って解説します。
Markdownとは
Markdownは、テキストに簡単な記号をつけるだけで、見出しや箇条書きなどの書式を表現できる書き方のルールです。
HTMLを書くより圧倒的に簡単で、GitHubのREADME、ブログ記事、ドキュメントなど、あらゆる場所で使われています。
よく使う書き方10選
1. 見出し
# 大見出し(h1)
## 中見出し(h2)
### 小見出し(h3)
# の数で見出しのレベルが変わります。
2. 太字・斜体
**太字**
*斜体*
***太字+斜体***
3. 箇条書き
- 項目1
- 項目2
- 項目3
- の代わりに * でもOKです。
4. 番号付きリスト
1. 最初にやること
2. 次にやること
3. 最後にやること
5. リンク
[表示テキスト](https://example.com)
例:[Google](https://google.com) → Google
6. 画像

7. コードブロック
```python
print("Hello, World!")
```
言語名を指定すると、シンタックスハイライト(色分け)がつきます。
8. インラインコード
`変数名` や `関数名` をこのように囲みます。
文中でコードを表示するときに使います。
9. 引用
> これは引用文です。
> 他の人の言葉を引用するときに使います。
10. 水平線
---
セクションの区切りに使います。
どこで練習できる?
- GitHubでリポジトリを作って
README.mdを編集する - VS Codeでプレビュー付きで書く(
Ctrl + Shift + V) - https://dillinger.io/ でブラウザ上で試す
まとめ
- Markdownは「記号で書式を表現する」シンプルな書き方
#で見出し、**で太字、-で箇条書き- GitHubのREADMEやブログ記事で必須
- まずは10個だけ覚えれば十分
あわせて読みたい
関連リソース
技術文書の書き方をもっと学びたい方へ:
リンク