Storybook: Anzeigen von Dokumenten im Storybook

Erstellt am 26. Apr. 2016  ·  3Kommentare  ·  Quelle: storybookjs/storybook

Im Moment ist die einzige Möglichkeit, Dokumente anzuzeigen, die Verwendung von:

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

Dies ist für die meisten unserer Komponenten nicht ausreichend...

In unserem Anwendungsfall wäre es schön, wenn wir:

  1. könnte etwas mehr Beschreibung hinzufügen (wie ein optionales Beschreibungs-Tag für die Geschichte)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. oder noch besser liest irgendwie die jsdocs in den js-Dateien und zeigt sie über den Komponentenbeispielen an:
/**
 * 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.
 */

Ich denke, das hängt irgendwie mit #56 zusammen, aber nicht ganz dasselbe.

Grüße,
Lukas

feature request

Hilfreichster Kommentar

Ich würde eine .md-Datei im Komponentenordner bevorzugen, die unten oder daneben gerendert wird.

Alle 3 Kommentare

Ja. Das ist toll.
Wenn wir das Dateisystem manuell benötigen, wird das etwas schwieriger und zu kompliziert.
Aber ich denke, es macht Sinn, dies mit der Geschichte voranzutreiben.

Auch dafür suchen wir mit Notizen etwas. Im Grunde haben wir damit einen weiteren Tab am unteren Rand namens "Notizen".

Ich würde eine .md-Datei im Komponentenordner bevorzugen, die unten oder daneben gerendert wird.

Mit diesem Addon behoben

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen