Markdownのすべての要素を、編集するとすぐに表示が反映される例で紹介します。改行、リンク、表、チェックボックス、脚注、コードブロック、GitHubのアラートに加え、READMEテンプレートも用意しています。
Markdownは、いくつかの記号でプレーンテキストを整形する記法です。見出しは#、太字は**アスタリスク2つ**、リンクは[テキスト](アドレス)、箇条書きは-、コードブロックはバッククォート3つを使います。下の例はすべて編集でき、隣のプレビューが入力に合わせて更新されるので、使う前に記法を試せます。
最もよく使う5つ
見出しから脚注、GitHubのアラートまでを網羅した18のライブ例、GitHubと標準のCommonMarkの違いをまとめた表、READMEテンプレート、そしてページ下部の本格的なエディターを用意しています。
行末に半角スペース2つかバックスラッシュを入れてから、Enterを押します。Enterだけだとスペースとして扱われ、行がつながってしまいます。改行ではなく新しい段落にしたい場合は、空行を1行入れます。
リスト項目を、空のボックスなら- [ ]、チェック済みなら- [x]で始めます。タスクリストはGitHub Flavored Markdownの機能なので、GitHub、GitLab、多くのノートアプリでは使えますが、厳密なCommonMarkでは使えません。
列の間をパイプで区切ってヘッダー行を書き、次にハイフンの行、その後に1行ずつデータ行を書きます。ソース上で列の位置をそろえる必要はありません。ハイフンの行にコロンを加えると、列を左寄せ、右寄せ、中央寄せにできます。
Markdownは2004年に生まれた元の記法で、多くのケースが未定義のままでした。CommonMarkは、その中核となる記法を厳密に定めた仕様です。GitHub Flavored Markdownは、CommonMarkに表、タスクリスト、取り消し線、自動リンク、脚注を加えたもので、多くの開発者向けツールが採用しています。
ほとんどのレンダラーで使えるため、READMEではdetailsタグやsummaryタグ、中央寄せの画像がよく使われます。GitHubは安全のため、スクリプト、スタイル、一部の属性を取り除きます。このページのプレビューは生のHTMLをレンダリングしないため、テキストとして表示します。
#を1〜6個書いてから半角スペースを入れます。#1つの見出しはドキュメントにつき1つにしましょう。
アンダースコア（__bold__、_italic_）も使えますが、単語の途中では機能しません。
両側にチルダを2つずつ付けます。GitHub Flavored Markdownの機能で、CommonMarkの中核には含まれません。
Enterを1回押しただけでは改行されません。行末に半角スペース2つかバックスラッシュを入れるか、空行を入れて新しい段落にします。
角括弧の中にテキスト、丸括弧の中にアドレスを書きます。山括弧で囲むと、アドレスだけでもクリックできるようになります。
長いアドレスを本文から切り離せます。定義はどこに書いてもよく、表示はされません。
リンクの先頭に!を付けた形です。角括弧の中のテキストが、スクリーンリーダーが読み上げる代替テキストになります。
箇条書きには-、*、+のいずれか、番号付きには1.を使います。入れ子にするには半角スペース2〜4つでインデントします。
角括弧の間が半角スペースなら未チェック、xならチェック済みです。GitHubではissueの中でチェックを付けられます。
各行を>で始めます。>だけの行を入れると、複数の段落を1つの引用にまとめられます。
バッククォートで囲むと、入力したとおりに表示されます。バッククォート自体を表示するには、2つで囲みます：`` a`b ``。
前後にバッククォートを3つずつ書きます。開始のフェンスの後ろに書いた単語で、ハイライトする言語を指定します。
パイプで列を区切り、ハイフンの行は必須です。コロンで配置（左寄せ、右寄せ、中央寄せ）を指定します。
ハイフン、アスタリスク、アンダースコアのいずれかを3つ以上、単独の行に書きます。ハイフンの場合は、見出しの下線と解釈されないよう前後に空行を入れましょう。
注はドキュメントの末尾にまとめられ、元の位置へ戻るリンクが付きます。
* _ # [ ] ` などの文字の前にバックスラッシュを付けると、プレーンテキストとして表示されます。
GitHubはアドレスをそのままリンクに変換します。厳密なCommonMarkでは山括弧が必要です。
GitHubではこれが色付きのボックスで表示されます。ほかのアプリでは、ここのプレビューと同じく通常の引用として表示されます。
Markdownの記法と使える環境
GitHub Flavored MarkdownとCommonMarkの違い
どこでも
GitHubと多くのアプリ
GitHubのみ
Markdown（編集できます）
プレビュー
コピー
リセット
記法の早見表
全要素のライブ例
GitHubとCommonMarkの違い
READMEテンプレート
テンプレートをコピー
エディターで開く
エディター
Markdown
Markdownをコピー
{n}語。何も保存・送信されません。
無料で始める · クレジットカード不要