2012-04-01 8 views
1

私は宝石の特徴をmy gemspecに挙げました。箇条書きをマークダウンスタイルで使っています。 rubygems.orgにプッシュすると、書式設定なしでone long lineの説明が出ます。私はその後、HTML(<ul> - ><li>)を使ってみましたが、それはプレーンテキストとしてレンダリングされました。gemspecの説明に箇条書きリストを書き、それをrubygems.orgでフォーマットできますか?

これを行う方法はありますか、またはすべてが大きな長い行になるという説明を書く必要がありますか?テキストstarts with何かがhereを文書化され、それはRDoc::Markupを通過しています/^==+ [A-Z]/を、一致する場合は、sourceをチェックして見ることができるように

答えて

2

あなたは

== Description 

- Bullet 1 
- Bullet 2 

ような何かにあなたの説明を設定した場合、それはRubyGemsのサイト上で適切にフォーマットする必要があります。

+0

私はgemspecのフィールドのドキュメントを読んでいましたが、これについては言及していません – d11wtq

0

RubyGems docsdescriptionによれば、もはや自動的にフォーマットされる:

をRubygemsののように記述の任意の自動書式がもはや存在しない1.3.2。それ以前のバージョンでは、記述を1行に再フォーマットしました。

RubyGems.orgはそのspecification-referencedescriptionフィールドを書式設定上の任意のより詳細な情報を提供していません。

RubyGems.orgは私が現時点で認識しているdescriptionフィールドの唯一の消費者なので、答えはあなたができないと思います。 :

+0

私は[bug 40](https://github.com/rubygems/guides/issues/40)をRubyGems.orgのガイドと照らし合わせてください。 –

関連する問題