Leiame do pacote em NuGet.org

  • Artigo

Inclua um arquivo Leiame em seu pacote NuGet para tornar os detalhes do pacote mais ricos e informativos para seus usuários!

Este é provavelmente um dos primeiros elementos que os usuários verão quando exibirem a página de detalhes do seu pacote em NuGet.org, sendo essencial para causar uma boa impressão!

Importante

O NuGet.org só oferece suporte a arquivos Leiame em Markdown e imagens de um conjunto limitado de domínios. Consulte nossos domínios permitidos para imagens e recursos de Markdown compatíveis para garantir que seu Leiame seja renderizado corretamente em NuGet.org.

O que meu Leiame deve incluir?

Considere incluir os seguintes itens:

  • Uma introdução que mostra o que é seu pacote e o que ele faz. Que problemas ele resolve?
  • Como começar a usar seu pacote: há requisitos específicos?
  • Links para documentação mais abrangente, se não incluída no próprio Leiame.
  • Pelo menos alguns trechos de código/exemplos ou imagens de exemplo.
  • Onde e como deixar comentários, como um link para os problemas do projeto, Twitter, rastreador de bugs ou outra plataforma.
  • Como contribuir, se for o caso.

Tenha em mente que Leiame de alta qualidade podem existir em uma grande variedade de formatos, formas e tamanhos! Se você já tem um pacote disponível em NuGet.org, é provável que você já tenha um readme.md ou outro arquivo de documentação em seu repositório que seria uma ótima adição à sua página de detalhes de NuGet.org.

Observação

Leia nosso blog sobre como escrever um LEIA-ME de alta qualidade para conhecer algumas práticas recomendadas.

Visualizar o Leiame

Para visualizar o arquivo Leiame antes que ele esteja ativo em NuGet.org, carregue seu pacote usando o portal da Web Carregar Pacote em NuGet.org e role para baixo até a seção "Arquivo Leiame" da visualização dos metadados. O resultado deve ser algo como:

Readme File preview

Considere reservar um tempo para revisar e visualizar seu arquivo Leiame para conformidade de imagem e formatação suportada para garantir que ele cause uma ótima primeira impressão nos usuários em potencial! Para corrigir erros no Leiame do pacote depois que ele for publicado no NuGet.org, será necessário enviar uma versão atualizada do pacote com a correção. Garantir que tudo pareça bom com antecedência poderá poupar dores de cabeça no futuro.

Domínios permitidos para imagens e selos

Devido a questões de segurança e privacidade, o NuGet.org restringe os domínios a partir dos quais imagens e selos podem ser renderizados para hosts confiáveis.

O NuGet.org permite que todas as imagens, incluindo selos, dos seguintes domínios confiáveis sejam renderizadas:

  • api.codacy.com
  • app.codacy.com
  • api.codeclimate.com
  • api.dependabot.com
  • api.travis-ci.com
  • api.reuse.software
  • app.fossa.com
  • app.fossa.io
  • avatars.githubusercontent.com
  • badge.fury.io
  • badgen.net
  • badges.gitter.im
  • buildstats.info
  • caniuse.bitsofco.de
  • camo.githubusercontent.com
  • cdn.jsdelivr.net
  • cdn.syncfusion.com
  • ci.appveyor.com
  • circleci.com
  • codecov.io
  • codefactor.io
  • coveralls.io
  • dev.azure.com
  • flat.badgen.net
  • github.com/.../workflows/.../badge.svg
  • gitlab.com
  • img.shields.io
  • i.imgur.com
  • isitmaintained.com
  • opencollective.com
  • raw.github.com
  • raw.githubusercontent.com
  • snyk.io
  • sonarcloud.io
  • travis-ci.com
  • travis-ci.org
  • wakatime.com
  • user-images.githubusercontent.com

Se você acha que outro domínio deve ser adicionado à lista de permissões, sinta-se à vontade para registrar um problema, e ele será revisado por nossa equipe de engenharia quanto à conformidade com questões de privacidade e segurança. Imagens com caminhos locais relativos e imagens hospedadas de domínios sem suporte não serão renderizadas e produzirão um aviso na página de visualização do arquivo Leiame e detalhes do pacote que só é visível para os proprietários do pacote.

Recursos de Markdown com suporte

O Markdown é uma linguagem de marcação leve com sintaxe de formatação de texto sem formatação. O NuGet.org oferece suporte a Markdown em conformidade com o CommonMark por meio do mecanismo de análise Markdig.

No momento, o NuGet.org oferece suporte aos seguintes recursos de Markdown:

Também oferecemos suporte ao realce de sintaxe, Você pode adicionar um identificador de idioma para habilitar o realce de sintaxe em suas extensões de código.