Giter VIP home page Giter VIP logo

connected-components-docs's Introduction

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 React documentation, snippets from components zeplin
Angular Plugin Generates Angular documentation, snippets from components zeplin
Swift Plugin Generates documentation, snippets from iOS, macOS views in Swift zeplin
Storybook Plugin Generates Storybook links of components zeplin, storybookjs
Vue Plugin Generates Vue documentation, snippets from 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 [email protected] if you have any questions or feedback.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.