WordPress readmeジェネレータとは何ですか?
WordPress readme ジェネレーターは、WordPress.org プラグイン ディレクトリが読み取る readme.txt ファイルをビルドして、プラグインの公開リストを作成します。ヘッダー フィールドとセクションを入力すると、ディレクトリが解析する正確な形式でファイルが送信されます - `=== プラグイン名 ===` タイトル、コロンで区切られたヘッダー ブロック、および `== セクション ==` 本体 - その横にライブ プレビューがあり、リスト ページがどのように表示されるかを示します。
形式は何かが間違うまで見えない方法でうるさいです。 `Stable tag` はディレクトリが実際に提供するバージョンに名前を付けているため、間違ったタグや欠落したタグは、何をコミットしても何も出荷しません。 `Tested up to` は、コアに遅れたときにリスティングに「あなたのバージョンの WordPress でテストされていない」という警告を生成するものです。 `Tags` は最初の 5 つにインデックスを付け、残りは静かに無視します。 短い説明は検索結果で 150 文字にカットされます。これらはいずれもファイルの書き込み中に表示されるエラーを生成しません。; これらは、見た目が間違っているリストや、起こらないダウンロードを生成します。このツールは、所属するフィールドの横に各制限を述べ、ディレクトリがファイルをダウンロードする前に何をするかを示します。
すべてがクライアント側で実行されます アップロードされるものは何もなく、アカウントが作成されず、下書きは独自のブラウザに保存されるため、リロードによって下書きが失われることはありません。また、既存の readme.txt をインポートすることもできます。プラグインがすでに出荷されているものに貼り付け、フォームに解析して戻します。これは、古いファイルを修正したり、readme を再入力せずに現在の要件に引き上げるための最速の方法です。異常な順序のセクション、このツールはモデル化されていないヘッダー行、一貫性のない間隔はすべて、拒否されるのではなく読み取られます。これは、実際の readme ファイルが次のとおりであるためです。
ファイル自体が持ち運べない2 つのことは、はっきり言う価値があります。 bannerとicon画像はreadme.txtの一部ではありません: 彼らは `banner-1544x500.png` と `icon-256x256.png` としてプラグインの `/assets/` フォルダに住んでいて、ここにあるフィールドは、プレビューが実際に取得するリストを表示するように動作します スクリーンショット - readme.txtは、番号付きのキャプションを運び、一致する `screenshot-1.png` ファイルは `/assets/` の順で入ります プレビューは、フォームの画像URLがWordPress.orgに表示されるふりをするのではなく、これについて正直です ファイルが正しくなったら、ダウンロードしてプラグインルートにドロップし、SVNリポジトリのトランクにコミットします。
WordPress readmeジェネレーターを使用するには?
見出しを記入します
プラグイン名、コントリビューターの WordPress.org ユーザー名、stable タグ、サポートする WordPress および PHP バージョン、および最大 5 つのタグ。これらは、ディレクトリが最初に解析するヘッダー ブロックになります。
説明を書く
検索リスト用の短い文を 1 つ、次に Markdown - ## headings の長い説明、**bold**、および * がプラグイン ページ上のすべてのレンダーをリストします。入力すると、フォームの横のプレビューが更新されます。
FAQ、スクリーンショット、変更ログを追加します
各 FAQ はそれぞれ = question = block になります。 screenshot キャプションは、アセットフォルダー内の screenshot-1.png ファイルに一致するように番号が付けられます。 changelog は、リリースごとに 1 = バージョン = ブロックを受け取ります。
警告を確認してからダウンロードしてください
「ディレクトリがこれで何をするのか」(安定タグが欠落している、長い短い説明、5 番目のタグを超える) を読み、readme.txt をダウンロードしてプラグインのトランクにコミットします。
主な機能
ライブディレクトリプレビュー
WordPress.org リスティングのバナー、アイコン、タブ、サイドバー。入力するとフィールドからレンダリングされるため、公開する前にページが表示されます。
既存の readme.txt をインポートします
このツールではモデル化されていない異常な順序とヘッダー行のセクションを含め、すでにフォームに戻している読み取り情報を解析します。
ディレクトリ自体の制限が記載されています
5 つのインデックス付きタグ、150 文字の短い説明、出荷するタグを決定する安定したタグ。各タグは該当するフィールドに表示され、ダウンロード前に要約されます。
ディレクトリがそれを受け入れる場所にマークダウンします
見出し、太字、リスト、リンクは、プラグイン ページ上の説明、インストール、変更履歴に正確に表示されます。
Frequently Asked Questions
Related Tools
WordPress Plugin Detector
See which WordPress plugins load on any page, with the folder slug, the version, the install count and the evidence each one came from.
WordPress Theme Detector
Find out which WordPress theme a site runs, with the version, the author, the parent theme and the evidence each answer came from.
Markdown Table Generator
Build Markdown tables in a spreadsheet-style editor - import CSV, Excel, or an existing table, set alignment, copy clean GFM
Markdown TOC Generator
Generate a linked table of contents from Markdown headings
Comments
0 comments
No comments yet. Be the first to share your thoughts!