NuGet.org 上的套件自述檔

在 NuGet 套件中包含自述檔，讓您的套件詳細數據更豐富且更具資訊性，讓使用者！

這可能是使用者在 NuGet.org 上檢視您的套件詳細數據頁面時會看到的第一個元素之一，對於給人留下良好的印象至關重要！

重要

NuGet.org 僅支援 Markdown 中的自述檔，以及來自一組有限網域的影像。請參閱我們允許的影像網域和支援的 Markdown 功能，以確保您的自述檔會在 NuGet.org 上正確轉譯。

我的自述文件應該包含哪些內容？

請考慮在自述檔中包含下列專案：

請記住，高品質的自述文字可以採用各種不同的格式、形狀和大小！如果您已在 NuGet.org 上提供套件，您可能已在存放庫中有 readme.md 或其他檔案檔案，這會是 NuGet.org 詳細數據頁面的絕佳新增專案。

注意

若要在 NuGet.org 上線之前預覽自述檔，請在 NuGet.org 上使用上傳套件入口網站上傳您的套件，然後向下捲動至元數據預覽的「自述檔」區段。其外觀應該如下所示：

Readme File preview

請考慮花時間檢閱及預覽您的自述檔，以取得影像合規性和支援的格式，以確保它給潛在使用者帶來絕佳的第一印象！若要修正套件自述檔發佈至 NuGet.org 時的錯誤，您必須使用修正來推送更新的套件版本。確保一切看起來都不錯，可能會讓你頭痛的路上。

由於安全性和隱私權考慮，NuGet.org 會限制影像和徽章轉譯至信任主機的網域。

NuGet.org 允許轉譯來自下列受信任網域的所有影像，包括徽章：

如果您覺得另一個網域應該新增至允許清單，請放心提出問題，且我們的工程小組將會檢閱其隱私權和安全性合規性。不會轉譯來自不支援網域之相對本機路徑和影像的影像，而且會在唯讀檔預覽和套件詳細數據頁面上產生警告，該頁面只會對套件擁有者顯示。

Markdown 是採用純文字格式語法的輕量型標記語言。 NuGet.org readmes 透過 Markdig 剖析引擎支援 CommonMark 相容 Markdown。

NuGet.org 目前支援下列 Markdown 功能：

我們也支援語法醒目提示，您可以新增語言標識符，以啟用程式代碼範圍中的語法醒目提示。