Partilhar via

Descrição do pacote no NuGet.org

Inclua um arquivo readme 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 utilizadores verão quando visualizarem a página de detalhes do seu pacote no NuGet.org e é essencial para causar uma boa impressão!

Importante

NuGet.org suporta apenas arquivos readme em Markdown e imagens de um conjunto limitado de domínios. Consulte nossos domínios permitidos para imagens e recursos de Markdown suportados para garantir que seu readme seja renderizado corretamente no NuGet.org.

O que o meu readme deve incluir?

Considere incluir os seguintes itens no seu readme:

  • Uma descrição do que é e o que faz o seu pacote - quais problemas ele resolve?
  • Como começar a usar o seu pacote - existem requisitos específicos?
  • Links para documentação mais abrangente, se não incluídos no próprio readme.
  • Pelo menos alguns trechos de código/exemplos ou imagens de exemplo.
  • Onde e como deixar feedback, como link para os problemas do projeto, Twitter, rastreador de bugs ou outra plataforma.
  • Como contribuir, se aplicável.

Por exemplo, pode começar com este modelo README de pacote.

# Package readme title, e.g., display name or title of the package (optional)

Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves.

## Getting started

Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.

### Prerequisites

What are specific minimum requirements to use your packages? Consider excluding this section if your package works without any additional setup beyond simple package installation.

## Usage

Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable. 

- Provide sample code using code snippets
- Include screenshots, diagrams, or other visual help users better understand how to use your package

## Additional documentation

Provide links to more resources: List links such as detailed documentation, tutorial videos, blog posts, or any other relevant documentation to help users get the most out of your package.

## Feedback

Where and how users can leave feedback?

- Links to a GitHub repository where could open issues, Twitter, a Discord channel, bug tracker, or other platforms where a package consumer can connect with the package author.

Tenha em mente que os ficheiros README de alta qualidade podem vir em grande variedade de formatos, formas e tamanhos! Se você já tem um pacote disponível no 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 NuGet.org.

Observação

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

Visualizar o seu ficheiro Leiame

Para visualizar seu arquivo readme antes que ele esteja ativo no NuGet.org, carregue seu pacote usando o portal da Web Upload Package no NuGet.org e role para baixo até a seção "Arquivo Leiame" da visualização de metadados. Deve ter um aspeto semelhante a:

Visualização do ficheiro Leiame

Considere reservar um tempo para revisar e visualizar seu arquivo readme para conformidade com a imagem e formatação suportada para garantir que ele dê uma ótima primeira impressão aos usuários em potencial! Para corrigir erros no leiame do pacote depois que ele for publicado no NuGet.org, você precisará enviar por push uma versão atualizada do pacote com a correção. Certificar-se de que tudo parece bom com antecedência pode poupar dor de cabeça no futuro.

Domínios permitidos para imagens e selos

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

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

  • api.codacy.com
  • api.codeclimate.com
  • api.dependabot.com
  • api.reuse.software
  • api.travis-ci.com
  • app.codacy.com
  • app.deepsource.com
  • avatars.githubusercontent.com
  • badgen.net
  • badges.gitter.im
  • camo.githubusercontent.com
  • caniuse.bitsofco.de
  • cdn.jsdelivr.net
  • cdn.syncfusion.com
  • ci.appveyor.com
  • circleci.com
  • cloudback.it
  • codecov.io
  • codefactor.io
  • coveralls.io
  • dev.azure.com
  • flat.badgen.net
  • github.com/.../workflows/.../badge.svg
  • gitlab.com
  • i.imgur.com
  • img.shields.io
  • infragistics.com
  • isitmaintained.com
  • media.githubusercontent.com
  • opencollective.com
  • raw.github.com
  • raw.githubusercontent.com
  • snyk.io
  • sonarcloud.io
  • travis-ci.com
  • travis-ci.org
  • 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 para conformidade de privacidade e segurança. As imagens com caminhos locais relativos e imagens hospedadas em domínios não suportados não serão renderizadas e produzirão um aviso na pré-visualização do arquivo readme e na página de detalhes do pacote, aviso este que é visível apenas para os proprietários do pacote.

Recursos de Markdown suportados

A Markdown é uma linguagem de markup simples com sintaxe de formatação de texto simples. NuGet.org readmes suportam Markdown compatível com CommonMark através do mecanismo de análise Markdig .

NuGet.org atualmente suporta os seguintes recursos de Markdown:

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

  • Last updated on