Bagikan melalui

Panduan Paket di NuGet.org

Sertakan file readme dalam paket NuGet Anda untuk membuat detail paket Anda lebih kaya dan lebih informatif bagi pengguna Anda!

Kemungkinan ini adalah salah satu elemen pertama yang akan dilihat pengguna ketika mereka melihat halaman detail paket Anda di NuGet.org dan sangat penting untuk membuat kesan yang baik!

Penting

NuGet.org hanya mendukung file readme di Markdown dan gambar dari sekumpulan domain terbatas. Lihat domain kami yang diizinkan untuk gambar dan fitur Markdown yang didukung untuk memastikan readme Anda dirender dengan benar di NuGet.org.

Apa yang harus disertakan dalam readme saya?

Pertimbangkan untuk menyertakan item berikut dalam readme Anda:

  • Pengenalan tentang apa itu paket Anda dan fungsinya - masalah apa yang diselesaikannya?
  • Bagaimana cara memulai paket Anda - apakah ada persyaratan khusus?
  • Tautan ke dokumentasi yang lebih komprehensif jika tidak disertakan dalam readme itu sendiri.
  • Setidaknya beberapa cuplikan/sampel kode atau gambar contoh.
  • Di mana dan cara meninggalkan umpan balik seperti tautan ke masalah proyek, Twitter, pelacak bug, atau platform lainnya.
  • Cara berkontribusi, jika berlaku.

Misalnya, Anda dapat memulai dengan templat README paket ini:

# 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.

Perlu diingat, readme berkualitas tinggi dapat hadir dalam berbagai format, bentuk, dan ukuran! Jika Anda sudah memiliki paket yang tersedia di NuGet.org, kemungkinan Anda sudah memiliki readme.md file dokumentasi atau lainnya di repositori Anda yang akan menjadi tambahan yang bagus untuk halaman detail NuGet.org Anda.

Nota

Baca blog kami tentang menulis README berkualitas tinggi untuk beberapa praktik terbaik.

Pratinjau readme Anda

Untuk mempratinjau file readme Anda sebelum ditayangkan di NuGet.org, unggah paket Anda menggunakan portal web Unggah Paket di NuGet.org dan gulir ke bawah ke bagian "File Readme" dari pratinjau metadata. Hasilnya akan terlihat seperti ini:

Pratinjau File Readme

Pertimbangkan untuk meluangkan waktu untuk meninjau dan mempratinjau file readme Anda untuk kepatuhan gambar dan pemformatan yang didukung untuk memastikannya memberikan kesan pertama yang bagus kepada calon pengguna! Untuk memperbaiki kesalahan pada readme paket Anda setelah diterbitkan ke NuGet.org, Anda harus mengunggah versi paket yang telah diperbarui yang sudah diperbaiki. Memastikan semuanya terlihat baik sebelumnya dapat menyelamatkan Anda sakit kepala di jalan.

Domain yang diizinkan untuk gambar dan lencana

Karena masalah keamanan dan privasi, NuGet.org membatasi domain tempat gambar dan lencana dapat dirender ke host tepercaya.

NuGet.org mengizinkan semua gambar, termasuk lencana, dari domain tepercaya berikut untuk ditampilkan.

  • 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

Jika Anda merasa bahwa domain lain harus ditambahkan ke daftar izinkan, jangan ragu untuk mengajukan masalah dan domain tersebut akan ditinjau oleh tim teknik kami untuk kepatuhan privasi dan keamanan. Gambar dengan jalur lokal relatif dan gambar yang dihosting dari domain yang tidak didukung tidak akan dirender dan akan menghasilkan peringatan pada pratinjau file readme dan halaman detail paket yang hanya terlihat oleh pemilik paket.

Fitur Markdown yang didukung

Markdown adalah bahasa markup ringan dengan sintaks pemformatan teks biasa. NuGet.org readmes mendukung Markdown yang mematuhi CommonMark melalui mesin penguraian Markdig .

NuGet.org saat ini mendukung fitur Markdown berikut:

Kami juga mendukung penyorotan sintaksis, Anda dapat menambahkan pengidentifikasi bahasa untuk mengaktifkan penyorotan sintaks dalam rentang kode Anda.

  • Last updated on