ToolHub
ツールを開く

README ジェネレーター

のため项目生成带徽章と標準章节の README.md ファイル

開発者ツール

このツールについて

README ジェネレーターさせる您填書く项目名称、描述、インストール、使用、贡献、许可能证と作者など情報,その後生成構造清晰の README.md ファイル,かつ提供リアルタイム Markdown プレビュー。您できますワンクリックでコピーまたはダウンロード结果,すべて操作均でブラウザ内完了。

主な機能

クイックプレビュー

使用シーン

readme markdown documentation generator project github

よくある質問

生成された README できます含む哪些章节?

您できます含む项目名称、描述、インストール说明、使用サンプル、贡献指南、许可能证と作者。各章节都です可能选の,只有填書くのコンテンツ才できます出今出力中。

ツールできます自动追加许可能证徽章か?

はい。当您入力许可能证名称(例えば MIT)時,ツールできます自动で生成された README 顶部追加 shields.io 许可能证徽章。

ダウンロード前できますプレビュー README か?

できます。ツール提供リアルタイム Markdown プレビューパネル,で你填書く各部分時リアルタイムレンダリング README。你できますで保存前看に README で GitHub または npm 上の最终外观。

できます追加テンプレート之外の定制部分か?

できます。除標準テンプレート部分外,你还できます追加带有カスタムタイトルとコンテンツの定制部分。这させる你できます根据特定项目要件定制 README,超越默认テンプレート構造。

ジェネレーター产生何出力形式?

ジェネレーター产生標準 Markdown(.md)フォーマット,这です GitHub、GitLab、npm と其他コード托管プラットフォーム上の README ファイルの通用フォーマット。你できますコピー出力またはダウンロードのため README.md ファイル供项目使用。