開発者ツール

README Generator — オープンソースドキュメントスケルトン

プロジェクト名と概要を入力し、Installation、Usage、API、Contributing、License の各セクションを切り替えて、ブラウザ内で構造化された README.md のスケルトンを生成できます。リポジトリや npm パッケージの立ち上げに役立ちます。

READMEMarkdownドキュメント

このツールをお気に入りに

お気に入りの保存方法がまだ選ばれていません。

クイック操作

このツールの URL をコピーするか、対応端末ではシステムの共有シートを開けます。

利用シーン

  • 新しいリポジトリの README スケルトンをすばやく作る
  • インストールと使用方法のセクションを標準化する
  • 実詳細を埋める前に README.md をエクスポートする

使い方

  1. プロジェクト名と短い説明を入力する
  2. 必要なセクションにチェックを入れる
  3. README.md をコピーまたはエクスポートする

入出力サンプル

プロジェクト

Cool-App + インストール/使い方

構造

# Cool-App\n## インストール\n## 使い方

FAQ

そのまま公開できますか?

実際のインストールコマンド、スクリーンショット、例は別途必要です。本ツールが提供するのは構造であり、プロジェクトの事実ではありません。

セクションを省略できますか?

はい。チェックを外したセクションは出力から省かれます。

ツール

関連ツール

近い用途の翻訳済みツールへ続けて進めます。

変更履歴ジェネレーター

Changelog Generator — Keep a Changelog テンプレート

利用可能

バージョン、日付、Added/Changed/Deprecated/Removed/Fixed/Security の各項目を入力し、ブラウザ内で Keep a Changelog 形式の Markdown を生成できます。リリースノートの整理に役立ちます。

Changelog リリース Markdown

ライセンスジェネレーター

License Generator — 一般的なオープンソースライセンス

利用可能

MIT、Apache-2.0、GPL などの一般的なライセンスを選び、著作権者を入力して、ブラウザ内でローカルに保存できる LICENSE テキストを生成します。法的助言ではありません。公式文書でご確認ください。

License オープンソース コンプライアンス

Shields.io バッジビルダー

Shields.io Badge Builder — Markdown ジェネレーター

利用可能

ラベル、メッセージ、色、スタイル、ロゴを設定し、ブラウザ内で Shields.io バッジの Markdown や URL をプレビュー・生成できます。README のビルドステータス、バージョン、技術スタックのバッジに役立ちます。

Shields バッジ Markdown