Freigeben über

Paketinfodatei auf NuGet.org

  • Artikel

Nehmen Sie eine Infodatei in Ihr NuGet-Paket auf, um Ihren Benutzern umfangreichere und informativere Detailinformationen zum Paket zu geben.

Dies ist wahrscheinlich eins der ersten Elemente, das Benutzer sehen, wenn sie Ihre Paketdetailseite auf NuGet.org anzeigen, und es ist wichtig, um einen guten Eindruck zu machen.

Wichtig

NuGet.org unterstützt nur Infodateien im Markdown-Format und Bilder aus einer begrenzten Gruppe von Domänen. Sehen Sie sich unsere zulässigen Domänen für Bilder und unterstützte Markdown-Funktionen an, um sicherzustellen, dass Ihre Infodatei ordnungsgemäß auf NuGet.org gerendert wird.

Was sollte meine Infodatei enthalten?

Erwägen Sie, die folgenden Elemente in Ihre Infodatei aufzunehmen:

  • Eine Einführung, was Ihr Paket ist und was es macht: welche Probleme löst es?
  • Informationen zu den ersten Schritten mit Ihrem Paket: Gibt es bestimmte Anforderungen?
  • Links zu einer umfassenderen Dokumentation, wenn sie nicht in der Infodatei selbst enthalten ist.
  • Mindestens einige Codeausschnitte/-beispiele oder Beispielbilder.
  • Wo und wie man Feedback hinterlasse kann, z. B. einen Link zu den Projektproblemen (project issues), Twitter, Bug Tracker oder einer anderen Plattform.
  • Wie man mitwirken kann, falls zutreffend.

Beachten Sie, dass hochwertige Infodateien eine Vielzahl von Formaten, Formen und Größen annehmen können. Wenn Sie bereits über ein Paket verfügen, das auf NuGet.org verfügbar ist, ist es wahrscheinlich, dass Sie bereits über eine readme.md oder eine andere Dokumentationsdatei in Ihrem Repository verfügen, die eine gute Ergänzung Ihrer Detailseite auf NuGet.org wäre.

Hinweis

Lesen Sie unseren Blog zum Schreiben einer hochwertigen README um einige bewährte Methoden kennenzulernen.

Anzeigen einer Vorschau Ihrer Infodatei

Um eine Vorschau Ihrer Infodatei anzuzeigen, bevor sie auf NuGet.org live geschaltet wird, laden Sie Ihr Paket über „Upload Package“ (Paket hochladen) im Webportal auf NuGet.org hoch, und scrollen Sie nach unten zum Abschnitt „Readme File“ (Infodatei) der Metadatenvorschau. Das sollte in etwa so aussehen:

Readme File preview

Nehmen Sie sich Zeit, um Ihre Readme-Datei auf Bilderkonformität und unterstützte Formatierungen zu überprüfen und in der Vorschau anzuzeigen, um sicherzustellen, dass sie potenziellen Benutzern einen guten ersten Eindruck vermittelt. Um Fehler in der Infodatei Ihres Pakets zu beheben, nachdem sie auf NuGet.org veröffentlicht wurde, müssen Sie eine aktualisierte Paketversion mit der Korrektur pushen. Wenn Sie im Voraus sicherstellen, dass alles gut aussieht, kann Ihnen das Kopfschmerzen auf dem weiteren Weg ersparen.

Zulässige Domänen für Bilder und Badges

Aus Sicherheits- und Datenschutzgründen schränkt NuGet.org Domänen ein, aus denen Bilder und Badges auf vertrauenswürdigen Hosts gerendert werden können.

NuGet.org lässt das Rendern aller Bilder, einschließlich Badges, aus den folgenden vertrauenswürdigen Domänen zu:

  • 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

Wenn Sie der Ansicht sind, dass der Zulassungsliste eine weitere Domäne hinzugefügt werden sollte, können Sie gerne ein Problem melden, das dann von unserem Technikteam auf Datenschutz- und Sicherheitskonformität überprüft wird. Bilder mit relativen lokalen Pfaden und Bilder, die von nicht unterstützten Domänen gehostet werden, werden nicht gerendert und erzeugen eine Warnung in der Vorschau der Infodatei sowie auf der Seite mit den Paketdetails, die nur dem Paketbesitzer angezeigt wird.

Unterstützte Markdown-Funktionen

Markdown ist eine schlanke Markupsprache mit Nur-Text-Formatierungssyntax. NuGet.org-Infodateien unterstützen CommonMark-konformes Markdown über die Analyse-Engine Markdig.

NuGet.org unterstützt derzeit die folgenden Markdown-Funktionen:

Wir unterstützen auch die Syntaxmarkierung, Sie können einen Sprachbezeichner hinzufügen, um die Syntaxmarkierung in Ihren Codespannen zu ermöglichen.