This page is for contributors. If you’re looking to use Create Figma Plugin, go to the documentation website.
Create Figma Plugin
![build](https://camo.githubusercontent.com/b0b9012bdb901f1dc3a665b1877af5e6089f4c9944b6d2d34cd30a699220438a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7975616e71696e672f6372656174652d6669676d612d706c7567696e2f6275696c642e796d6c3f6272616e63683d6d61696e2663616368655365636f6e64733d31383030)
The comprehensive toolkit for developing plugins and widgets for Figma and FigJam
- Introduction
- Quick start
- Configuration
- UI
- Utilities
- Recipes
- Reference plugins/widgets
- Storybook
- Changelog
Contributing
Pre-requisites
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
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