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:
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
.add('some configuation, () => (
<SomeComponent />
)).(...)
/**
* 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
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
Comentários muito úteis
Eu prefiro um arquivo .md na pasta do componente, renderizado abaixo ou ao lado.