Storybook: ストーリーブック内にドキュメントを表示する

作成日 2016年04月26日  ·  3コメント  ·  ソース: storybookjs/storybook

現時点では、ドキュメントを表示する唯一の方法は次を使用することです。

storiesOf('Main story', module)
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)

これはほとんどのコンポーネントには不十分です...

私たちのユースケースでは、次のようにすると便利です。

  1. さらに説明を追加できます(ストーリーのオプションの説明タグなど)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. または、どういうわけかjsファイル内のjsdocsを読み取り、コンポーネントの例の上に表示します。
/**
 * Represents a book.
 * <strong i="16">@constructor</strong>
 * <strong i="17">@param</strong> {string} title - The title of the book.
 * <strong i="18">@param</strong> {string} author - The author of the book.
 */

これはどういうわけか#56に関連していると思いますが、まったく同じではありません。

よろしく、
ルカス

feature request

最も参考になるコメント

コンポーネントフォルダにある.mdファイルを、下または横にレンダリングしたほうがいいです。

全てのコメント3件

うん。 これは素晴らしい。
ファイルシステムが手動で必要な場合、それは少し難しく、複雑になります。
しかし、ストーリーでこれを推し進めることは理にかなっていると思います。

私たちはまた、メモでこれのために何かを探しています。 基本的に、下部に「メモ」と呼ばれる別のタブがあります。

コンポーネントフォルダにある.mdファイルを、下または横にレンダリングしたほうがいいです。

このアドオンで修正

このページは役に立ちましたか?
0 / 5 - 0 評価