Storybook: Menampilkan dokumen di dalam buku cerita

Dibuat pada 26 Apr 2016  ·  3Komentar  ·  Sumber: storybookjs/storybook

Saat ini satu-satunya cara untuk menampilkan dokumen adalah dengan menggunakan:

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

Ini tidak cukup untuk sebagian besar komponen kami...

Dalam kasus penggunaan kami, alangkah baiknya jika kami:

  1. dapat menambahkan beberapa deskripsi lagi (seperti tag deskripsi opsional untuk cerita)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. atau bahkan lebih baik entah bagaimana membaca jsdocs di file js dan menampilkannya di atas contoh komponen:
/**
 * 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.
 */

Saya pikir ini entah bagaimana terkait dengan #56 tetapi tidak persis sama.

Salam,
Lukas

feature request

Komentar yang paling membantu

Saya lebih suka file .md di folder komponen, dirender di bawah atau di samping.

Semua 3 komentar

Ya. Ini bagus.
Jika kita membutuhkan sistem file secara manual, itu akan sedikit lebih sulit dan lebih rumit.
Tapi, saya pikir mendorong ini dengan cerita masuk akal.

Kami juga mencari sesuatu untuk ini dengan catatan. Pada dasarnya, dengan itu kami memiliki Tab lain di bagian bawah yang disebut "Catatan".

Saya lebih suka file .md di folder komponen, dirender di bawah atau di samping.

Diperbaiki dengan addon ini

Apakah halaman ini membantu?
0 / 5 - 0 peringkat