Archivo Léame del paquete en NuGet.org

  • Artículo

Incluya un archivo Léame en el paquete NuGet para que los detalles del paquete sean más completos e informativos para los usuarios.

Este es probablemente uno de los primeros elementos que los usuarios verán cuando consulten la página de detalles del paquete en NuGet.org y es esencial para causar una buena impresión.

Importante

NuGet.org solo admite archivos Léame en Markdown e imágenes de un conjunto limitado de dominios. Consulte los dominios permitidos para las imágenes y las características admitidas de Markdown para asegurarse de que el archivo Léame se represente correctamente en NuGet.org.

¿Qué debe incluir mi archivo Léame?

Considere la posibilidad de incluir los siguientes elementos en el archivo Léame:

  • Introducción a lo que es y hace el paquete: ¿qué problemas soluciona?
  • ¿Cómo empezar a trabajar con el paquete? ¿Hay requisitos específicos?
  • Vínculos a documentación más completa si no se incluye en el propio archivo Léame
  • Al menos algunos fragmentos de código, ejemplos o imágenes de ejemplo
  • Dónde y cómo dejar comentarios, como el vínculo a los problemas del proyecto, Twitter, el seguimiento de errores u otra plataforma
  • Cómo contribuir, si procede

Tenga en cuenta que los archivos Léame de alta calidad pueden tener una amplia variedad de formatos, formas y tamaños. Si ya tiene un paquete disponible en NuGet.org, lo más probable es que ya disponga de un archivo de documentación readme.md u otro en el repositorio que sería una gran adición a la página de detalles de NuGet.org.

Nota:

Lea nuestro blog sobre cómo escribir un archivo LÉAME de alta calidad para ver algunos procedimientos recomendados.

Vista previa del archivo Léame

Para obtener una vista previa del archivo Léame antes de que se use en NuGet.org, cargue el paquete mediante Portal web: use la pestaña Upload Package (Cargar paquete) en nuget.org y desplácese hacia abajo hasta la sección "Archivo Léame" de la versión preliminar de metadatos. Debe tener el siguiente aspecto:

Readme File preview

Considere la posibilidad de dedicar un tiempo a revisar y obtener una vista previa del archivo Léame para el cumplimiento de imágenes y el formato admitido para asegurarse de que da una excelente primera impresión a los usuarios potenciales. Para corregir errores en el archivo Léame del paquete una vez que se publica en NuGet.org, deberá insertar una versión actualizada del paquete con la corrección. Asegurarse de que todo está bien por adelantado puede ahorrarle problemas en el futuro.

Dominios permitidos para imágenes y notificaciones

Debido a problemas de seguridad y privacidad, NuGet.org restringe los dominios desde los que se pueden representar imágenes y notificaciones en hosts de confianza.

NuGet.org permite representar todas las imágenes, incluidas las notificaciones, de los siguientes dominios de confianza:

  • 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

Si cree que se debe agregar otro dominio a la lista de permitidos, no dude en presentar una incidencia y la revisará nuestro equipo de ingenieros para comprobar el cumplimiento de la privacidad y la seguridad. Las imágenes con rutas de acceso locales relativas y las imágenes hospedadas en dominios no admitidos no se representarán y producirán una advertencia en la vista previa del archivo Léame y en la página de detalles del paquete que solo es visible para los propietarios del paquete.

Características de Markdown admitidas

Markdown es un lenguaje de marcado ligero con sintaxis de texto sin formato. Los archivos Léame de NuGet.org admiten Markdown compatible con CommonMark mediante motor de análisis de Markdig.

NuGet.org admite actualmente las siguientes características de Markdown:

Como también se admite el resaltado de sintaxis, puede agregar un identificador de idioma para habilitar el resaltado de sintaxis en los intervalos de código.