Storybook: Affichage des documents à l'intérieur du livre de contes

Créé le 26 avr. 2016  ·  3Commentaires  ·  Source: storybookjs/storybook

Pour le moment, le seul moyen d'afficher les documents est d'utiliser :

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

C'est insuffisant pour la plupart de nos composants...

Dans notre cas d'utilisation, ce serait bien si nous :

  1. pourrait ajouter une description supplémentaire (comme une balise de description facultative pour l'histoire)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. ou encore mieux, lit les jsdocs dans les fichiers js et les affiche au-dessus des exemples de composants :
/**
 * 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.
 */

Je pense que c'est en quelque sorte lié au #56 mais pas tout à fait pareil.

Salutations,
Lukas

feature request

Commentaire le plus utile

Je préférerais un fichier .md dans le dossier des composants, rendu ci-dessous ou à côté.

Tous les 3 commentaires

Ouais. C'est bien.
Si nous avons besoin du système de fichiers manuellement, ce sera un peu plus difficile et compliqué.
Mais, je pense que pousser cela avec l'histoire a du sens.

Nous recherchons également quelque chose pour cela avec des notes. Fondamentalement, avec cela, nous avons un autre onglet en bas appelé "Notes".

Je préférerais un fichier .md dans le dossier des composants, rendu ci-dessous ou à côté.

Corrigé avec cet addon

Cette page vous a été utile?
0 / 5 - 0 notes