Zeplin Connected Components Documentation
Connected Components in Zeplin enables developers to access components in their codebase right on the designs—with links to Storybook, GitHub and any other source of documentation based on your workflow.
After connecting your components in Zeplin to your components in code, you'll be able to get a high level overview of the component right on the designs, like so:
To get started, check out the quick start guide:
For more details, see our manual configuration guides for specific frameworks/platforms:
Once you connect your components, check out these follow-up guides:
- Adding repository links, e.g. GitHub, GitLab, Bitbucket
- Adding custom links, e.g. internal Design System wiki
- Adding Storybook links
- Adding Styleguidist links
- Test your changes locally
Other related documents:
Connected Components is built with modularity and extensibility in mind. Plugins generate documentation, code snippets, links and so on to be displayed in Zeplin—pick and choose the plugins you need based on the language, platform and tools you prefer.
|React Plugin||Generates documentation, snippets for React and React Native components||zeplin|
|Angular Plugin||Generates documentation, snippets for Angular components||zeplin|
|Swift Plugin||Generates documentation, snippets for iOS, macOS views in Swift||zeplin|
|Storybook Plugin||Generates Storybook links for components||zeplin, storybookjs|
|Vue Plugin||Generates documentation, snippets for Vue components||politico|
|StencilJS Plugin||Generates documentation, snippets for StencilJS Web Components||fmontes|
To build your own plugin (either for internal use or sharing publicly), check out our CLI plugins documentation.
Reach out to us at firstname.lastname@example.org if you have any questions or feedback.