Компоненты и документация в гармонии наконец
Сборник рассказов — это стандартный инструмент для разработки компонентов пользовательского интерфейса, который используется для создания самых популярных систем проектирования в Интернете, включая Shopify Polaris, IBM Carbon, Salesforce Lightning, Auth0 Cosmos и Airbnb Lunar.
Качественная документация, подобная этой, имеет решающее значение для того, чтобы помочь людям повторно использовать ваши компоненты пользовательского интерфейса, но это также является огромной болью для правильной работы. На практике вы тратите больше времени на поддержку вашей системы документации, чем на самом деле написание документов!
Именно поэтому в Storybook мы одержимы стремлением сделать документацию по компонентам пользовательского интерфейса быстрой и простой. Нашим первым шагом был Doc sPage, инструмент для автоматического создания документации по лучшим практикам из ваших существующих историй.
И сегодня я рад представить быстрые, полностью настраиваемые документы в Storybook, работающие на основе MDX и доступен в сборнике рассказов 5.3-beta! 🎉
MDX позволяет настраивать автоматически сгенерированную документацию Storybook с вашими собственными компонентами, смешивать и сочетать DocBlocks и выполнять цикл в нетехнических товарищах по команде. Все изнутри удобных границ Markdown.
- 🎨 Настраиваемые документы: Полностью настраиваемая документация, упрощенная.
- 📦 Готовые строительные блоки: Повторное использование мощных DocBlocks Storybook.
- 🤝 Совместная запись документов: Мощный для разработчиков, легкий для дизайнеров и менеджеров ПО
- 🔌 100% совместимость: [194593] ] Полная интеграция Storybook с нулевой конфигурацией
Ранее в этом году команда изложила амбициозную концепцию переосмысления документации по компонентам. Нашей первой вехой стала Storybook 5.2, в которой был представлен DocsPage для автоматической генерации лучших документов пользовательского интерфейса из ваших существующих историй.
Документы Storybook взлетели как ракета, став одним из самых популярных инструментов для документирования (по загрузкам npm). ) в считанные недели! Но даже когда команды приняли DocsPage, желание написать полностью пользовательскую документацию было очевидно.
Storybook MDX дает авторам компонентов беспрецедентный баланс гибкости, чистоты и легкости. MDX — это открытый, создаваемый формат, который плавно чередует компоненты Markdown и JSX в одном файле. Это позволяет легко компоновать стандартные строительные блоки, такие как цветовые палитры, образцы типографий и таблицы свойств, в документацию полной формы.
Более того, простой опыт создания MDX означает дизайнеров, менеджеров ПО, и любой, кто знаком с Markdown, может внести свой вклад в общую документацию пользовательского интерфейса. Бесстрашные пользователи альфа и бета уже используют Storybook как единый источник истины для своих библиотек компонентов и систем проектирования.
Загрузка...
