Гиперссылка в описании пакета NuGet в .nuspec

Я разрабатываю пакет NuGet и храню его с открытым исходным кодом на github.com.

Мой пакет после установки требует выполнения нескольких шагов настройки в решении VS, и я документирую это в файле README.md на github.

Я хотел бы сослаться на этот файл README.md в пакете NuGet, чтобы люди знали, что делать после установки пакета.

Я указал <projectUrl> в своем файле .nuspec, указывающем на мой репозиторий Git на github. Но для пользователей не очевидно, что им нужно щелкнуть по ней, чтобы прочитать документацию.

Я хотел бы, чтобы пользователи могли перейти по ссылке, чтобы прочитать полную документацию. Было бы неплохо иметь гиперссылку, например, в поле <description> файла .nuspec, чтобы она отображалась как гиперссылка на:

  • страница проекта на nuget.org
  • сведения о пакете, отображаемые в Visual Studio при просмотре\установке пакета

Я пробовал разные способы добавить ссылку, например, экранирование XML < и > как &lt; и &gt;, но она не отображается как ссылка, а просто как текст html.


person Ivan    schedule 11.01.2017    source источник
comment
Отображение гиперссылки не поддерживается. Единственное, что вы можете сделать, это включить файл readme.txt в свой пакет NuGet. Он будет открыт Visual Studio при установке пакета NuGet.   -  person Matt Ward    schedule 12.01.2017
comment
Благодарю вас! Это интересная идея. Пойду пока по этому пути. Если хотите - опубликуйте это как ответ, и я приму его.   -  person Ivan    schedule 12.01.2017


Ответы (1)


‹ licenseUrl> и ‹ projectUrl> — это два тега, которые будут отображать гиперссылку в диспетчере пакетов NuGet. Вы не можете предоставлять гиперссылки в каких-либо других тегах. Если вы хотите предоставить гиперссылку, используйте любой из них. В противном случае вы можете использовать файл readme.

person Mathivanan KP    schedule 19.01.2017