2017-01-11 38 views
1

我正在開發一個NuGet包,並保持它的開放源碼github.com說明超鏈接的NuGet包的.nuspec

安裝後,我的包需要幾個配置步驟與解決方案來完成,我在github上的README.md文件中記錄了這一點。

我想在NuGet包中引用這個README.md文件,這樣人們就知道在安裝包後應該做什麼。

我在指定<projectUrl>在我的.nuspec文件指向我的Git倉庫github上。 但用戶不需要點擊它來閱讀文檔。

我想讓它響亮而清晰,讓用戶按照鏈接閱讀完整文檔。 這將是很好有一個超鏈接,例如在.nuspec文件的<description>領域,所以它的顯示爲超鏈接:

  • 項目頁面上nuget.org
  • 包詳細信息瀏覽\安裝包

我已經嘗試了不同的方式來添加一個鏈接時,例如在Visual Studio中顯示XML轉義<>&lt;&gt;但它並不SH將它作爲一個鏈接,但只是一個HTML文本。

+1

不支持顯示超鏈接。你可能做的唯一的事情是在你的NuGet包中包含一個readme.txt文件。當您安裝NuGet包時,Visual Studio將打開該文件。 –

+0

謝謝!這是一個有趣的想法。現在會走這條路。如果你想 - 發佈這個答案,我會接受它。 – Ivan

回答

1

< licenseUrl>和< projectUrl>是兩個標籤,它們將在NuGet包管理器中顯示超鏈接。您不能在任何其他標籤中提供超鏈接。如果你想提供一個超鏈接使用這些。否則,您可以使用自述文件。