Могу ли я написать список маркеров в описании gemspec и отформатировать его на rubygems.org?

Question

Я перечислил свойства драгоценного камня в моем gemspec , используя маркеры в стиле уценки. При нажатии на rubygems.org описание выводится на одной длинной строке без какого-либо форматирования. Затем я попытался использовать HTML (<ul> -> <li>), но он просто отображался как простой текст.

Есть ли способ сделать это, или мы должны написать описание, что все идет по большой длинной линии?

Answer 1

Как вы можете увидеть, проверив источник , если текст начинается с что-то, совпадающее с /^==+ [A-Z]/, то он проходит через RDoc::Markup, что задокументировано здесь .

Если вы установите для своего описания что-то вроде

== Description

- Bullet 1
- Bullet 2

Тогда оно должно быть правильно отформатировано на сайте rubygems.

Answer 2

Согласно Документам RubyGems description больше не форматируется автоматически:

Примечания:

По состоянию на Rubygems 1.3.2 больше нетлюбое автоматическое форматирование описания.Версии, предшествовавшие этому, переформатировали описание в одну строку.

RubyGems.org не предоставляет никакой дополнительной информации о форматировании поля description в его спецификации -reference .

Поскольку RubyGems.org является единственным потребителем поля description, о котором я знаю в данный момент, я думаю, что ответ вы не можете.: - (