Storybook: عرض المستندات داخل كتاب القصة

تم إنشاؤها على ٢٦ أبريل ٢٠١٦  ·  3تعليقات  ·  مصدر: storybookjs/storybook

في الوقت الحالي ، الطريقة الوحيدة لعرض المستندات هي استخدام:

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

هذا غير كافٍ لمعظم مكوناتنا ...

في حالة الاستخدام الخاصة بنا ، سيكون من الجيد أن:

  1. يمكن إضافة المزيد من الوصف (مثل علامة وصف اختيارية للقصة)
storiesOf('Main story', module, 'This component can be used to ... and has the following params ...')
  .add('some configuation, () => (
    <SomeComponent />
  )).(...)
  1. أو يقرأ بشكل أفضل محرّر jsdocs في ملفات js ويعرضها فوق أمثلة المكوّنات:
/**
 * 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.
 */

أعتقد أن هذا مرتبط إلى حد ما بالرقم 56 ولكن ليس هو نفسه تمامًا.

يعتبر،
لوكاس

feature request

التعليق الأكثر فائدة

أفضل ملف .md في مجلد المكون ، المعروض أدناه أو بجانبه.

ال 3 كومينتر

بلى. هذا عظيم.
إذا احتجنا إلى نظام الملفات يدويًا ، فسيكون ذلك أصعب قليلاً وأكثر تعقيدًا.
لكني أعتقد أن دفع هذا بالقصة أمر منطقي.

نحن نبحث أيضًا عن شيء لهذا مع الملاحظات. في الأساس ، لدينا علامة تبويب أخرى في الأسفل تسمى "ملاحظات".

أفضل ملف .md في مجلد المكون ، المعروض أدناه أو بجانبه.

ثابت مع هذا الملحق

هل كانت هذه الصفحة مفيدة؟
0 / 5 - 0 التقييمات

القضايا ذات الصلة

tomitrescak picture tomitrescak  ·  3تعليقات

arunoda picture arunoda  ·  3تعليقات

ZigGreen picture ZigGreen  ·  3تعليقات

zvictor picture zvictor  ·  3تعليقات

miljan-aleksic picture miljan-aleksic  ·  3تعليقات