QiitaのMarkdown記法まとめ|よく使う書き方一覧
QiitaのMarkdown記法とは
QiitaはGitHub Flavored Markdown(GFM)をベースにした記法で記事を書きます。記号を組み合わせるだけで見出しや表が作れるため、慣れるとキーボードから手を離さずに整った記事が書けます。ここではQiitaの執筆画面で実際に使える基本記法を、書き方とあわせて整理します。なお記法に迷ったら、執筆画面のツールバーやプレビューで結果を確認しながら進めるのが確実です。
見出し
行頭に # を置くと見出しになります。# の数で大きさが変わり、# から ###### まで6段階です。Qiitaでは # とテキストの間に半角スペースを入れる必要があります。
# 大見出し ## 中見出し ### 小見出し
記事構成は ##(h2)と ###(h3)を中心に組み立てると、見出しの階層が読者に伝わりやすくなります。
リスト(箇条書き・番号付き)
箇条書きは行頭に -、*、+ のいずれかとスペースを置きます。番号付きリストは 1. のように数字とドット、スペースを使います。
- りんご - みかん 1. 手順の最初 2. 次の手順
行頭に半角スペースを入れてからリスト記号を書くと、入れ子(ネスト)になります。
リンクと強調
リンクは [表示テキスト](URL) の形式で書きます。強調は記号で囲むだけです。
[Qiita](https://qiita.com) **太字** _斜体_ ~~取り消し線~~
太字は ** または __、斜体は * または _、取り消し線は ~~ でテキストを囲みます。URLをそのまま貼っても自動でリンクになります。
コードと引用
文中の短いコードはバッククオート1つで囲みます。複数行のコードはバッククオート3つで囲み、開始行に言語名を書くとシンタックスハイライトが効きます。
`変数名` のように囲むとインラインコードになります。
Qiitaでは 言語名:ファイル名 のように書くとファイル名も表示できます。コードブロックの詳しいオプションは別記事に譲り、ここでは概要にとどめます。引用は行頭に > を置きます。
> これは引用文です。 > 行ごとに > を付けます。
表(テーブル)
表はパイプ | で列を区切り、2行目のハイフン - でヘッダーと本文を分けます。ハイフンにコロン : を添えると、列ごとの揃え(左・中央・右)を指定できます。
| 項目 | 値 | |:---|---:| | 名前 | 太郎 | | 点数 | 90 |
上の例では左列が左揃え、右列が右揃えになります。セルの数が多少ずれても表示されますが、列数は揃えておくと安全です。
チェックボックス
箇条書きの記号のあとに [ ] を続けるとチェックボックスになります。[x] と書くとチェック済みの状態で表示されます。
- [ ] 未完了のタスク - [x] 完了したタスク
TODOリストや手順の確認に便利です。- とブラケットの間、ブラケット内のスペースを忘れないようにしましょう。
絵文字
コロンで絵文字名を囲むと絵文字を挿入できます。たとえば :smile: や :tada: のように書きます。使える名前は決まっているので、表示されない場合は名前を確認してください。
まとめ
見出し・リスト・リンク・強調・コード・引用・表・チェックボックスを押さえれば、Qiitaの記事はほぼ書けます。まずは見出しと箇条書きで骨組みを作り、必要に応じて表やコードブロックを足していくと、迷わず構成できます。書いた内容はプレビューで都度確認するのがおすすめです。
補足: 執筆を補助する非公式ツール
筆者は、qiita.comの執筆画面にAI補助のサイドバーを追加する非公式のChrome拡張「Qiita-AI+」を個人開発しています(Qiita公式とは無関係です)。無料でタイトル候補とLGTM予測、冒頭文3案、章立ての提案、タグ最適化、読みやすさ評価が使えます(無料は毎日利用でき、回数の上限があります)。無制限に使いたい場合はPro(月¥980)があり、APIキーは自分のもの(BYOK)を使う方式です。記法そのものとは別の話なので、構成出しを少し楽にしたい方への参考として紹介します。