Изолированная среда разработки компонентов React с живым руководством по стилю

Официальный сайт: https://react-styleguidist.js.org/

React Styleguidist — это среда разработки компонентов с перезагружаемым сервером разработки и живым руководством по стилю, которым вы можете поделиться со своей командой. В нем перечислены компоненты propTypes и показаны живые редактируемые примеры использования на основе файлов Markdown. Ознакомьтесь с демонстрационным руководством по стилю.

Гитхаб



Установить гида по стилю

Установите веб-пакет, если у вас его еще нет и вы не используете приложение Create React:

npm install --save-dev webpack

Установите StyleGuidist:

npm install --save-dev react-styleguidist

Следуйте документу: https://react-styleguidist.js.org/docs/getting-started.html#1-install-styleguidist\

использование

Расширенная документация

Примеры

Витрина

Реальные проекты с использованием React Styleguidist:

Интеграция с другими инструментами

Сторонние инструменты

  • snapguidist: тестирование снимков для React Styleguidist
  • react-styleguidist-visual: автоматизированное визуальное тестирование для React Styleguidist с использованием Puppeteer и pixelmatch.
  • styleguidist-scrapper: сценарий очистки документации, сгенерированной React Styleguidist.

Удачного кодирования :)