MarkdownLab

READMEジェネレーター

17種類のセクションライブラリから必要なものを選び、並べ替え、それぞれを入力すると、GitHub風のプレビューがリアルタイムで更新されます — 完成したREADME.mdをコピーまたはダウンロードできます。

すべての処理はブラウザ内で完結します — ファイルが外部に送信されることはありません。

セクション
選択中(8)
追加可能

ここでの内容 — 選んだセクションとその内容 — はすべてこのブラウザ(localStorage)内に保存され、どこにもアップロードされません。バッジ画像は、プレビューが表示される際にブラウザがshields.ioから取得します。

使い方

  1. 01デフォルトのセクション構成(タイトルと説明、バッジ、インストール、使い方、機能、コントリビューション、ライセンス、謝辞)から始めるか、ライブラリから技術スタック、スクリーンショット、APIリファレンス、環境変数、FAQなどのセクションを追加します。
  2. 02「選択中」内のセクションをクリックすると中央の列で編集できます。矢印ボタンで並べ替え、×で削除します。
  3. 03各セクションのフォーム項目を入力するか、技術スタックやロードマップのような自由記述セクションはMarkdownを直接編集します。
  4. 04「バッジ」セクションを開くと、shields.ioのバッジを作成できます — ライセンスバッジ(ライセンスで選んだ内容と連動)、npmバージョン、ビルドステータス、PR歓迎バッジなどです。
  5. 05右側のプレビューを確認(または「ソース」に切り替えてMarkdownソースを確認)し、完成したREADME.mdをコピーまたはダウンロードします。

よくある質問

セクションを空欄のままにするとどうなりますか?

生成されるREADMEからそのセクションが丸ごと除外されます — 中身のない空の「## Usage」見出しが出力されることはありません。自由記述セクション(技術スタック、ロードマップ、FAQなど)も同様です:テキストエリアを空にすると、そのセクションは出力から消えます。

実際のLICENSEファイルも生成されますか?

いいえ、READMEのライセンスセクションに短い説明とライセンス本文へのリンクが含まれるだけです。対応するLICENSEファイルはリポジトリに別途追加してください(GitHubも同じ選択肢からLICENSEファイルを追加できます:MIT、Apache 2.0、GPL v3、BSD 3-Clause、MPL 2.0、Unlicense)。

バッジセクションはどのように機能しますか?

小さなshields.ioバッジビルダーです:ライセンスバッジ(デフォルトではライセンスセクションで選んだ内容に連動しますが、独立して設定することもできます)、npmバージョンバッジ(パッケージ名を入力)、ビルド成功バッジとPR歓迎バッジ、そして任意で「Made with MarkdownLab」バッジも追加できます — いずれも、後から自由に編集できる通常のMarkdown画像リンクとして組み立てられます。

この内容はサーバーに送信されますか?

いいえ。すべてのセクションはブラウザのJavaScript内でMarkdownに組み立てられます。選択したセクションとその内容はこのブラウザのローカルストレージにのみ保存されるため(再読み込みしても作業内容は失われません)、どこにもアップロードされません。唯一の例外はバッジ画像で、プレビューがレンダリングされる際にshields.ioから直接取得されます。

生成後も結果を編集し続けられますか?

はい — コピーまたはダウンロードした後、Markdownエディタ(や任意のテキストエディタ)で開いてさらに磨き込めます。このジェネレーターは、固定テンプレートではなく、しっかりと構造化された出発点を提供するものです。

関連ツール