Skip to content
Documentation for Connected Components
Branch: master
Clone or download

Latest commit

Latest commit 0f429a4 Mar 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Update STORYBOOK.md Apr 1, 2020
img Delete unused image Feb 26, 2020
.gitignore Add docs Feb 9, 2020
CONFIGURATION_FILE.md Update Styleguidist parameter name Feb 25, 2020
README.md Merge pull request #10 from zeplin/mention-react-native Feb 27, 2020

README.md

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:

Connected component in Zeplin

Getting started

For details on how to use Connected Components in Zeplin, check out our getting started guides for various platforms/frameworks:

If your platform/framework is not listed here, you can still use Connected Components—check out our getting started guide for all platforms/frameworks.

Once you connect your components, check out these follow-up guides:

Configuration file documentation

For details on how to work with the .zeplin/components.json configuration file, check out the Configuration file documentation.

Plugins

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.

Name Description Created by
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

To build your own plugin (either for internal use or sharing publicly), check out our CLI plugins documentation.

☝️ It is possible to use Connected Components without any plugins and still display links to your internal wiki or your repository.

Need help?

Reach out to us at support@zeplin.io if you have any questions or feedback.

You can’t perform that action at this time.