7

我正在开发一个 NuGet 包并在 github.com 上保持开源

安装后我的包需要在 VS 解决方案中完成一些配置步骤,我将其记录在 github 上的 README.md 文件中。

我想在 NuGet 包中引用这个 README.md 文件,以便人们知道包安装后要做什么。

我在.nuspec<projectUrl>文件中指定了指向我在 github 上的 Git 存储库。但是对于用户来说,他们需要单击它来阅读文档并不明显。

我想让用户按照链接阅读完整文档的声音清晰明了。最好有一个超链接,例如在.nuspec<description>文件的字段中,因此它在以下位置显示为超链接:

  • nuget.org 上的项目页面
  • 浏览\安装包时在 Visual Studio 中显示的包详细信息

我尝试了不同的方法来添加链接,例如 XML 转义<>as &lt;&gt;但它不会将其显示为链接,而只是显示为 html 文本。

4

1 回答 1

4

< licenseUrl> 和 < projectUrl> 是两个标签,它们将在 NuGet 包管理器中显示超链接。您不能在任何其他标签中提供超链接。如果您想提供超链接,请使用其中任何一个。否则,您可以使用自述文件。

于 2017-01-19T09:07:36.530 回答