Storybook: Visualización de documentos dentro del libro de cuentos

Creado en 26 abr. 2016  ·  3Comentarios  ·  Fuente: storybookjs/storybook

Por el momento, la única forma de mostrar documentos es el uso de:

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

Esto es insuficiente para la mayoría de nuestros componentes ...

En nuestro caso de uso, sería bueno si nosotros:

  1. podría agregar más descripción (como una etiqueta de descripción opcional para la historia)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. o incluso mejor, lee los jsdocs en los archivos js y los muestra sobre los ejemplos 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.
 */

Creo que esto está relacionado de alguna manera con el número 56, pero no es exactamente lo mismo.

Saludos,
Lukas

feature request

Comentario más útil

Preferiría un archivo .md en la carpeta del componente, representado debajo o al lado.

Todos 3 comentarios

Sí. Esto es genial.
Si necesitamos el sistema de archivos manualmente, será un poco más difícil y complicado.
Pero, creo que empujar esto con la historia tiene sentido.

También estamos buscando algo para esto con notas. Básicamente, con eso tenemos otra pestaña en la parte inferior llamada "Notas".

Preferiría un archivo .md en la carpeta del componente, representado debajo o al lado.

Corregido con este complemento

¿Fue útil esta página
0 / 5 - 0 calificaciones