Изолированная среда разработки компонентов 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\
использование
- Приступая к работе: установите и запустите Styleguidist
- Документирование компонентов: как писать документацию
- Расположение компонентов: укажите Styleguidist на ваши компоненты React
- Настройка веб-пакета: сообщите Styleguidist, как загрузить ваш код
- Поваренная книга: как решать типичные задачи с помощью Styleguidist
Расширенная документация
Примеры
- Базовое руководство по стилю, исходник
- Руководство по стилю с разделами исходник
- Руководство по стилю с настроенными стилями, исходник
- Руководство по стилю с пользовательскими экспресс-конечными точками, источник
- Создать интеграцию приложения React, источник
Витрина
Реальные проекты с использованием React Styleguidist:
- Рамбл чарты
- лучше реагировать на спинкит
- Семантические компоненты пользовательского интерфейса для React
- Компоненты диалога
- Булма Компоненты
- Компоненты Yammer
- Еще проекты…
Интеграция с другими инструментами
- Create React App — поддерживается из коробки, см. руководство Начало работы
- Создайте приложение React + TypeScript, см. Настройка веб-пакета
- TypeScript, см. react-docgen-typescript
- Vue, см. Vue Styleguidist
Сторонние инструменты
- snapguidist: тестирование снимков для React Styleguidist
- react-styleguidist-visual: автоматизированное визуальное тестирование для React Styleguidist с использованием Puppeteer и pixelmatch.
- styleguidist-scrapper: сценарий очистки документации, сгенерированной React Styleguidist.
Удачного кодирования :)