https://github.com/fmontes/zeplin-cli-connect-plugin-stenciljs
Zeplin CLI plugin to generate descriptions and code snippets for StencilJS Web Components.
https://github.com/fmontes/zeplin-cli-connect-plugin-stenciljs
Last synced: about 2 months ago
JSON representation
Zeplin CLI plugin to generate descriptions and code snippets for StencilJS Web Components.
- Host: GitHub
- URL: https://github.com/fmontes/zeplin-cli-connect-plugin-stenciljs
- Owner: fmontes
- Created: 2020-09-21T23:11:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-21T06:34:43.000Z (almost 4 years ago)
- Last Synced: 2025-04-29T20:08:42.376Z (about 2 months ago)
- Language: TypeScript
- Size: 50.8 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Zeplin CLI Stencil JS Plugin
[Zeplin CLI](https://github.com/zeplin/cli) plugin to generate descriptions and code snippets for React components.
## Installation
Install the plugin using npm.
```sh
npm install -g zeplin-cli-connect-plugin-stenciljs
```
## Usage
1. Generate the [StencilJS](https://stenciljs.com/) json docs, update you `stencil.config.ts` file and inside the `outputTargets` property add:
```
outputTargets: [
{
type: 'docs-json',
file: 'path/to/file.json'
},
]
```
and then run `npm run build` to generate the file
2. In your `.zeplin/components.json` configuration file, add the plugin and pass the stencil docs file:
```
"plugins": [
{
"name": "cli-connect-stenciljs-plugin",
"config": {
"sourcePath": 'path/to/file.json'
}
}
]
```
3. Run CLI `connect` command using the plugin.
```sh
zeplin connect
```
## About Connected Components
[Connected Components](https://blog.zeplin.io/introducing-connected-components-components-in-design-and-code-in-harmony-aa894ed5bd95) 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](https://github.com/zeplin/cli) uses plugins like this one to analyze component source code and publishes a high-level overview to be displayed in Zeplin.