GitHub と同じ見た目のプレビューを見ながら README.md を書ける無料の README エディターです。クリックできる目次、タスクリスト、表、コードブロックに対応しています。サンプルの README から始めて、ツールバーやショートカットで書式を付け、.md ファイルや単体で開ける HTML ページとしてダウンロードできます。下書きは入力中にブラウザーへ保存されます。
使い方
- エディタにMarkdownを書くか、.md ファイルをドロップ・選択・貼り付けで開きます。最初はサンプルのREADMEが表示されます。
- ツールバーやショートカットで、太字、斜体、見出し、リンク、リスト、タスクリスト、コード、引用、表を挿入できます。
- 「プレビュー」でクリックできる目次付きのGitHub風の表示を、「HTML」で生成されたHTMLを確認できます。
- HTMLをコピーするか、スタイル付きの単体 .html ページ、または .md ファイルとしてダウンロードできます。
- GitHub Flavored Markdown（表、タスクリスト、コードブロック、取り消し線、自動リンク）に対応。見出しにはGitHubと同じ形式のアンカーIDが付きます。
- 出力HTMLはサニタイズされ、スクリプトや危険な属性は取り除かれます。
- 下書きはこのブラウザに自動保存され、次に開いたときもそのまま残っています。
- 画面が広いときは「分割」でエディタとプレビューを並べて表示できます。
よい README に書くこと
README はリポジトリで最初に読まれる文書なので、「何をするものか」「どうインストールするか」「どう使うか」の 3 点にすぐ答えられるようにします。よくある構成は、1 行の説明、短い例やスクリーンショット、インストール手順、コードブロック付きの使い方、設定、コントリビュート方法、ライセンスの順です。最初の段落には専門用語を詰め込まず、詳細は後ろに回しましょう。
言語名を付けたコードブロック（```js、```bash）は GitHub で色分け表示されます。docs/setup.md のような相対リンクはリポジトリ内で機能し、画像もリポジトリ内のファイルを指定できます。
GitHub Flavored Markdown
プレビューは CommonMark を拡張した GitHub Flavored Markdown（GFM）に従います。見出し、リスト、リンク、強調に加えて、縦棒で書く表、- [ ] と - [x] のタスクリスト、~~取り消し線~~、URL の自動リンク、囲み付きコードブロックが使えます。各見出しには GitHub と同じ形式のアンカー ID が付き、#installation のようなリンクでその節へ移動できます。目次はこのしくみを使っています。日本語の見出しもアンカーになります。
よくある質問
README に目次を付けるには？
- [使い方](#使い方) のように、見出しのアンカーへのリンクを並べたリストを書きます。GitHub でもプレビューと同じように動きます。プレビューの目次で各見出しとアンカーを確認できます。
Markdownでタスクリスト（チェックボックス）はどう書きますか？
行頭に - [ ] と書くと未完了、- [x] と書くと完了のタスクになります。GitHub の Issue やプルリクエストでは直接チェックできます。
GitHub の表やコードブロックに対応していますか？
はい。表は | で列を区切り、見出し行の下にハイフンの行を入れます。コードブロックはバッククォート 3 つで囲みます。
下書きは保存されますか？
このブラウザーに自動で保存され、次に開いたときも残っています。アップロードはされません。
HTML を取り出せますか？
はい。HTML 表示に切り替えると、無害化済みの HTML をコピーできます。スタイル付きの単体 .html ページもダウンロードできます。