【发布时间】:2017-05-26 11:59:49
【问题描述】:
我正在开发一个 NuGet 包并在 github.com 上保持开源
安装后我的包需要在 VS 解决方案中完成一些配置步骤,我在 github 上的 README.md 文件中记录了这一点。
我想在 NuGet 包中引用这个 README.md 文件,以便人们知道包安装后要做什么。
我在 .nuspec 文件中指定了<projectUrl>,指向我在 github 上的 Git 存储库。
但是对于用户来说,需要点击它来阅读文档并不明显。
我想让用户点击链接阅读完整文档。
最好有一个超链接,例如在 .nuspec 文件的 <description> 字段中,因此它在以下位置显示为超链接:
- nuget.org 上的项目页面
- 浏览\安装包时在 Visual Studio 中显示包详细信息
我尝试了不同的方法来添加链接,例如 XML 转义 &lt; 和 &gt; 为 &lt; 和 &gt; 但它不会将其显示为链接,而只是显示为 html文本。
【问题讨论】:
-
不支持显示超链接。您唯一可以做的就是在 NuGet 包中包含一个 readme.txt 文件。安装 NuGet 包时,Visual Studio 将打开它。
-
谢谢!这是一个有趣的想法。暂时会走这条路。如果你愿意 - 将此作为答案发布,我会接受。
标签: nuget nuget-package nuget-spec nuspec