Markdownエディター
Markdown記法を書いて、リアルタイムでプレビューを確認します。
Markdownエディターへようこそ
太字、斜体、取り消し線が使えます。
- リスト項目1
- リスト項目2
- 子項目
- 番号付きリスト
- 2番目の項目
これは引用です。
インラインコードとコードブロック:
console.log("こんにちは");
リンクや表も追加できます。
| 項目 | 値 |
|---|---|
| A | 1 |
| B | 2 |
使用例
READMEや技術文書の下書きを書く
GitHubのREADMEやドキュメントが実際どう表示されるか確認したい場合は?左側で書きながら右側でリアルタイムに結果を確認できます。
表やリストが正しく表示されるか確認する
Markdownの表記法に自信がない場合は?入力するとすぐにプレビューで表やリストがどう表示されるか確認できます。
書きかけの内容を後で続きから書く
入力中の内容はブラウザに自動保存されるので、ページを閉じてもまた開けば続きから書けます。
チェックリスト付きのPR説明文を書く
「- [ ] テストを追加」のようなチェックリストや入れ子になった箇条書きを使ってPRの説明文を下書きし、GitHubがチェックボックスとインデントをどう表示するかを貼り付ける前にプレビューで確認できます。
コードスニペット入りのリリースノートを整形する
見出し、箇条書きの変更履歴、関数名のインライン`コード`を組み合わせたリリースノートを書き、アップグレードコマンド用のフェンス付きコードブロックが正しい言語ハイライトで表示されるか確認できます。
よくある質問
書いた内容はサーバーに保存されますか?
いいえ。すべての編集とプレビュー表示はブラウザ内でのみ行われます。再訪問時に続きから書けるよう、内容はブラウザのローカルストレージ(localStorage)にのみ保存され、サーバーに送信されたり他の端末と共有されたりすることはありません。
対応していないMarkdown記法はありますか?
見出し、太字・斜体・取り消し線、リスト、引用、コード(インライン・ブロック)、リンク、画像、表(GFM拡張記法)まで、よく使われる記法に対応しています。Markdown内に直接HTMLタグを混ぜても、安全のため実行されずそのまま文字として表示されます。
書いたMarkdownを他で使えますか?
はい。上部の「コピー」ボタンを押すと、書いた内容全体がクリップボードにコピーされます。または「README.mdとして書き出す」を押すとファイルとしてダウンロードされ、GitHubリポジトリなどにそのままアップロードできます。
改行を1つ入れただけではプレビューで改行されないのはなぜですか?
これは標準的なMarkdown(CommonMark)の仕様どおりです。段落内の単一の改行はスペースとして扱われ、改行にはなりません。強制的に改行したい場合は、行末に半角スペースを2つ以上入れるか、完全に空の行を入れて新しい段落を始めてください。
リストや引用を入れ子にすることはできますか?
はい。リスト項目をスペース2つでインデントすると上の項目の下に入れ子にでき、同じようにリスト項目の中に引用やコードブロック、別のリストを入れることもできます。入力するたびにプレビューに入れ子構造が反映されます。
ツールバーはキーボードショートカットに対応していますか?
ツールバーのボタンは、カーソル位置に正しいMarkdown記法(選択したテキストを太字用の**で囲むなど)を挿入しますが、マウスやタッチでの利用を想定したものです。ブラウザやOS標準の編集ショートカット以外に、専用のキーボードショートカットは用意されていません。
うっかりタブを閉じてしまったら内容はどうなりますか?
入力内容は入力するたびにローカルストレージへ保存されるため、同じブラウザでツールを開き直せば、以前の状態がそのまま復元されます。ブラウザのサイトデータを消去するか、別のブラウザや端末を使った場合にのみ失われます。