Skip to content

zeplin/connected-components-docs

master
Switch branches/tags
Code

Latest commit

* Add docs for storybook integration via GUI

* Add .idea to ignored files

* Apply suggestions from code review

Co-authored-by: Yucel Okcu <yucel.n.okcu@gmail.com>

Co-authored-by: Yucel Okcu <yucel.n.okcu@gmail.com>
416a52a

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
img
 
 
 
 
 
 

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

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:

Other related documents:

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
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.

☝️ 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.

About

Documentation for Connected Components

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published