/cli-connect-react-plugin

Zeplin CLI plugin for React components

Primary LanguageTypeScriptMIT LicenseMIT

Zeplin CLI React Plugin

Zeplin CLI plugin to generate descriptions and code snippets for React components.

Installation

Install the plugin using npm.

npm install -g @zeplin/cli-connect-react-plugin

Usage

Run CLI connect command using the plugin.

zeplin connect -p @zeplin/cli-connect-react-plugin

Zeplin CLI React Plugin uses react-docgen to analyze and collect information from React components. For more details about the supported formats, see react-docgen guidelines.

About Connected Components

Connected Components in Zeplin lets you access components in your codebase directly on designs in Zeplin, with links to Storybook, GitHub and any other source of documentation based on your workflow. šŸ§©

Zeplin CLI uses plugins like this one to analyze component source code and publishes a high-level overview to be displayed in Zeplin.