README.md ジェネレーター
短いフォームに入力するだけで、バッジ、インストール、使い方、機能、コントリビュート、ライセンスの各節を備えた整った GitHub の README.md を作成。Markdown のライブプレビュー付き。
owner/repo 形式。バッジと git clone コマンドに使います。
1 行に 1 つの機能。
見出しはオープンソースの README で一般的な英語で書かれます。入力したテキストはそのまま使われます。
関連ツール
すべて表示README ジェネレーターとは？
README はリポジトリで最初に読まれるファイルです。このツールは、プロジェクト名、説明、機能、インストールと使い方のコマンド、ライセンス、作者といった数個の項目から、任意の shields.io バッジ、目次、コントリビュートガイド付きの、構造の整った README.md を作ります。Markdown のソースとレンダリングされた プレビュー を切り替えられます。
README ジェネレーターの使い方
- プロジェクト名 を入力し、GitHub 上にある場合は GitHub リポジトリ を
owner/repoの形で入力します。 - 一行キャッチコピー、説明、主な機能（1 行に 1 つ）、インストールコマンド、使用例 を追加します。
- ライセンス を選び、作者 を追加して、バッジ、目次、コントリビュート節 を切り替えます。
- プレビュー を確認し、README.md をコピーまたはダウンロードします。
例
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
README ジェネレーターを使うべき場面
新しいライブラリ、CLI、個人プロジェクト、社内リポジトリの README を 1 分で用意し、その後で文章を手で磨き上げるときに使います。作られるのは適切な骨組みであって、ドキュメントそのものではありません。設定や API の詳細、プロジェクト固有の例は、自分で説明する必要があります。
README ジェネレーターの仕組み
フォームの内容は GitHub Flavored Markdown に組み立てられます。名前の H1、任意のバッジ（img.shields.io のライセンス、スター、Issue。リポジトリへリンク）、引用ブロックのキャッチコピー、続いて主な機能、インストール（リポジトリを設定した場合は git clone + cd のブロック付き）、使い方（選んだ言語のフェンス付きコードブロック）、コントリビュート、ライセンス、作者の各節が並びます。目次のリンクには GitHub の見出しアンカーの規則が使われます。プレビューは marked でレンダリングされ、DOMPurify でサニタイズされます。
一般的な使用例
- 新しいオープンソースパッケージの README をひな形から作る
- チームのリポジトリ間で README の構成を標準化する
- ライセンスとコントリビュートの節をすばやく追加する
- ポートフォリオやハッカソンのプロジェクトの README を作成する
よくある質問
LICENSE ファイルも作成されますか？
いいえ。LICENSE へのリンクを含むライセンス節を追加するだけです。ライセンス本文は自分でリポジトリに追加してください（GitHub が作成することもできます）。
見出しが英語なのはなぜですか？
英語の節見出しはオープンソースの README の慣例で、世界中のコントリビューターがプロジェクトを把握しやすくなります。入力したテキストは、書いた言語のままです。
バッジはプライベートリポジトリでも動作しますか？
shields.io は GitHub のプライベートリポジトリを読み取れないため、スターと Issue のバッジは公開リポジトリでのみデータを表示します。