Command Palette

Search for a command to run...

GE

Gerador de leitura WordPress

Escreva um plugin readme.txt nas análises de diretório do WordPress.org, com uma visualização ao vivo da listagem que ele produz e um download quando estiver certo.

O que é um gerador de readme WordPress?

Um gerador de readme WordPress constrói o arquivo readme.txt que o diretório do plugin WordPress.org lê para criar a listagem pública de um plugin. Você preenche os campos de cabeçalho e as seções, e ele emite o arquivo no formato exato que o diretório analisa - o `=== Nome do plugin ===título do plural, o bloco de cabeçalho separado por dois pontos e o `== Seção ==` bodies - com uma visualização ao vivo ao lado mostrando como será a página de listagem.

O formato é agitado de maneiras que são invisíveis até que algo esteja errado. ` stable tag` names the version the directory really serves, so a wrong or missing tag ships nothing no matter what you committed. `Tested up to` is what productes the "untested with your version of WordPress" warning on the listing when it lags behold core. `Tags` indexes the first five and silently ignores the rest. A breve descrição é cortada em 150 caracteres nos resultados de pesquisaNenhum destes produz um erro que você vê ao escrever o arquivo; eles produzem uma listagem que parece errada ou um download que não acontece, dias depois Esta ferramenta afirma cada limite ao lado do campo ao qual pertence, e lista o que o diretório faria com seu arquivo antes de baixá-lo.

Tudo corre no lado do cliente Nada é carregado, nenhuma conta é criada e o rascunho é mantido em seu próprio navegador para que uma recarga não o perca Você também pode importar um readme.txt existente - cole no que seu plugin já envia e ele é analisado de volta no formulário, que é a maneira mais rápida de corrigir um arquivo antigo ou trazer um readme até os requisitos atuais sem redigitá-lo Seções em uma ordem incomum, linhas de cabeçalho que esta ferramenta não modela e espaçamento inconsistente são todos lidos em vez de recusados, porque é assim que os arquivos reais de readme se parecem.

Duas coisas que o arquivo em si não pode carregar valem a pena dizer claramente As imagens de banner e ícone não fazem parte do readme.txt: elas vivem na pasta `/assets/` do plugin como `banner-1544x500.png` e `icon-256x256.png`, e os campos aqui existem para que a visualização mostre a listagem que você realmente obterá As capturas de tela funcionam da mesma maneira - readme.txt carrega as legendas numeradas, e os arquivos `screenshot-1.png` correspondentes vão em `/assets/` nessa ordem A visualização é honesta sobre isso, em vez de fingir que uma URL de imagem no formulário aparecerá no WordPress.org. Assim que o arquivo estiver certo, baixe-o, solte-o na raiz do plugin e comprometa-o no tronco do seu repositório SVN.

Como usar o gerador de readme WordPress?

  1. Preencha os títulos

    O nome do plugin, os nomes de usuário WordPress.org dos colaboradores, a tag estável, as versões WordPress e PHP que você suporta e até cinco tags Estes se tornam o bloco de cabeçalho que o diretório analisa primeiro.

  2. Escreva a descrição

    Uma frase curta para a listagem de pesquisa, em seguida, a descrição longa em Markdown - ## cabeçalhos, ** negrito ** e * lista todos os render na página do plugin A visualização ao lado do formulário atualiza conforme você digita.

  3. Adicione perguntas frequentes, capturas de tela e changelog

    Cada FAQ torna-se seu próprio = pergunta = bloco As legendas da captura de tela são numeradas para corresponder aos arquivos screenshot-1.png em sua pasta de ativos O changelog leva um = versão = bloco por lançamento, o mais novo primeiro.

  4. Verifique os avisos e baixe

    Leia "O que o diretório faria com isso" - uma tag estável ausente, uma descrição curta e longa, tags após a quinta - e baixe readme.txt e comprometa-o no tronco do seu plugin.

Principais características

  • Visualização do diretório ao vivo

    O banner, ícone, guias e barra lateral de uma listagem do WordPress.org, renderizados a partir de seus campos enquanto você digita, para que você veja a página antes de publicá-la.

  • Importar um readme.txt existente

    Analisa um readme que você já enviou de volta para o formulário, incluindo seções em uma ordem incomum e linhas de cabeçalho que esta ferramenta não modela.

  • Os próprios limites do diretório, afirmou

    Cinco tags indexadas, uma breve descrição de 150 caracteres, uma tag estável que decide o que vem - cada uma mostrada no campo ao qual se aplica e resumida antes do download.

  • Markdown onde o diretório aceita

    Cabeçalhos, negrito, listas e links renderizam na descrição, instalação e changelog exatamente como farão na página do plugin.

Frequently Asked Questions

Sim, é gratuito e não precisa de inscrição Ele executa o lado do cliente em seu navegador, então não há servidor fazendo o trabalho e nada para cobrar.

Comments

0 comments

0/2000 characters

No comments yet. Be the first to share your thoughts!

wordpress readme generatorreadme.txt generatorplugin readme generatorwordpress plugin readmereadme txt wordpress plugingenerate readme for wordpress pluginwordpress readme validatorplugin directory listing