Storybook: Exibindo documentos dentro do livro de histórias

Criado em 26 abr. 2016  ·  3Comentários  ·  Fonte: storybookjs/storybook

No momento, a única maneira de exibir documentos é usando:

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

Isso é insuficiente para a maioria dos nossos componentes ...

Em nosso caso de uso, seria bom se nós:

  1. poderia adicionar mais alguma descrição (como uma tag de descrição opcional para a história)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. ou melhor ainda, lê os jsdocs nos arquivos js e os exibe acima dos exemplos de componentes:
/**
 * 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.
 */

Eu acho que isso está de alguma forma relacionado ao # 56, mas não exatamente o mesmo.

Cumprimentos,
Lukas

feature request

Comentários muito úteis

Eu prefiro um arquivo .md na pasta do componente, renderizado abaixo ou ao lado.

Todos 3 comentários

Sim. Isso é ótimo.
Se precisarmos do sistema de arquivos manualmente, será um pouco mais difícil e complicado.
Mas, acho que empurrar isso com a história faz sentido.

Também estamos procurando algo para isso com notas. Basicamente, com isso temos outra aba na parte inferior chamada "Notas".

Eu prefiro um arquivo .md na pasta do componente, renderizado abaixo ou ao lado.

Corrigido com este addon

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

tirli picture tirli  ·  3Comentários

levithomason picture levithomason  ·  3Comentários

dnlsandiego picture dnlsandiego  ·  3Comentários

ZigGreen picture ZigGreen  ·  3Comentários

miljan-aleksic picture miljan-aleksic  ·  3Comentários