https://github.com/divriots/create-figma-plugin
https://github.com/divriots/create-figma-plugin
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/divriots/create-figma-plugin
- Owner: divriots
- License: mit
- Created: 2023-04-07T16:15:58.000Z (about 3 years ago)
- Default Branch: v2.3.0-divriots
- Last Pushed: 2024-08-06T15:06:24.000Z (almost 2 years ago)
- Last Synced: 2025-07-18T07:44:18.236Z (11 months ago)
- Language: TypeScript
- Size: 9.05 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
*This page is for contributors. If you’re looking to use Create Figma Plugin, [go to the documentation website](https://yuanqing.github.io/create-figma-plugin/).*
---
# [Create Figma Plugin](https://yuanqing.github.io/create-figma-plugin/) [](https://npmjs.com/package/create-figma-plugin) [](https://github.com/yuanqing/create-figma-plugin/actions?query=workflow%3Abuild)
> The comprehensive toolkit for developing plugins and widgets for Figma and FigJam
- [Introduction](https://yuanqing.github.io/create-figma-plugin/)
- [Quick start](https://yuanqing.github.io/create-figma-plugin/quick-start/)
- [Configuration](https://yuanqing.github.io/create-figma-plugin/configuration/)
- [UI](https://yuanqing.github.io/create-figma-plugin/ui/)
- [Utilities](https://yuanqing.github.io/create-figma-plugin/utilities/)
- [Recipes](https://yuanqing.github.io/create-figma-plugin/recipes/)
- [Reference plugins/widgets](https://yuanqing.github.io/create-figma-plugin/reference-plugins-and-widgets/)
- [Storybook](https://yuanqing.github.io/create-figma-plugin/storybook/)
- [Changelog](/CHANGELOG.md#readme)
## Contributing
### Pre-requisites
- [Node.js](https://nodejs.org) – v18
- [npm](https://docs.npmjs.com/cli/) – v9
### Building the project locally
```
$ git clone https://github.com/yuanqing/create-figma-plugin
$ cd create-figma-plugin
$ git checkout --track origin/next
$ npm install
```
Active development on the next release occurs on the [`next`](https://github.com/yuanqing/create-figma-plugin/tree/next) branch. Pull requests should be made into `next`.
### Testing changes on an existing plugin/widget
First, build the entire Create Figma Plugin project:
```
$ npm run build
```
Then, create symlinks to the local copy of the project in your existing plugin/widget (eg. `my-project`):
```
$ ls -a
create-figma-plugin my-project
$ sh create-figma-plugin/scripts/symlink.sh create-figma-plugin my-project
```
Finally, build your plugin/widget:
```
$ cd my-project
$ npm run build
```