{"id":14981580,"url":"https://github.com/yagudaev/figma-to-json","last_synced_at":"2025-04-09T17:26:10.221Z","repository":{"id":145006882,"uuid":"537603500","full_name":"yagudaev/figma-to-json","owner":"yagudaev","description":"💾 Read/Write Figma Files as JSON","archived":false,"fork":false,"pushed_at":"2024-03-15T18:12:46.000Z","size":4618,"stargazers_count":246,"open_issues_count":9,"forks_count":33,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T16:07:28.128Z","etag":null,"topics":["backup","deisgn","figma","figma-plugin"],"latest_commit_sha":null,"homepage":"https://figma2json.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yagudaev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-09-16T20:03:27.000Z","updated_at":"2025-03-24T08:07:56.000Z","dependencies_parsed_at":"2024-01-31T01:28:24.147Z","dependency_job_id":"3317ee04-75ab-4226-bd49-a2c3baaf468b","html_url":"https://github.com/yagudaev/figma-to-json","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yagudaev%2Ffigma-to-json","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yagudaev%2Ffigma-to-json/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yagudaev%2Ffigma-to-json/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yagudaev%2Ffigma-to-json/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yagudaev","download_url":"https://codeload.github.com/yagudaev/figma-to-json/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248076156,"owners_count":21043722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","deisgn","figma","figma-plugin"],"created_at":"2024-09-24T14:03:53.011Z","updated_at":"2025-04-09T17:26:10.198Z","avatar_url":"https://github.com/yagudaev.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Figma To JSON 💾\n\nA set of tools to programatically work with Figma files as JSON. You can use these to read and write your own figma documents without opening figma.\n\n[🔥 Live Demo 🔥](https://www.figma2json.com)\n\n![Figma to JSON Plugin Screenshot](website/public/assets/images/plugin-screenshot.png)\n\n## Motivation 🤔\n\nWe believe you should own your data and be able to browse, edit and export anything you choose out of your design tools.\n\nIn an era of AI 🤖 and Open Source software, we believe design formats should also be open-source. This is our gift to the community 🎁.\n\n## Quick Start ⚡️\n\n### Install the plugin\n\n1. Download the latest release https://github.com/yagudaev/figma-to-json/releases\n2. Unzip the file to a folder\n3. In the Figma desktop app, open a Figma document.\n4. Search for and run `Import plugin from manifest…` via the Quick Actions search bar.\n5. Select the manifest you unzipped in step 2\n\n### Usage\n\nhttps://user-images.githubusercontent.com/1386966/191097407-02263aec-f335-4c3b-92c6-e475cc3b53f1.mp4\n\n1. In the Figma desktop app, open a Figma document.\n2. Search for an run `Figma To JSON` via the Quick Actions search bar.\n3. Click `Download JSON` and select a folder to download to\n\nNow you can inspect the JSON file with any text editor. We recommend using VS Code.\n\n## Supported Formats ✅\n\n### .fig files\n\nFigma files ending with [.fig are private and internal](https://forum.figma.com/t/inquiry-about-the-fig-file-format/6351). However, since figma does not provide a write API it is useful to create new designs.\n\nFuthermore, if the Figma REST API is down you can be sure to use this format.\n\n### Figma Plugin JSON\n\nFigma Plugin API uses a different JSON shape to the REST API. It only works when running inside of Figma Editor.\n\n### Figma Rest API (Coming soon)\n\nFigma REST API provides a way to access other files by Plugins and for automating workflows without running Figma.\n\nThe REST API is developed by a separate team at Figma and contains read-only functionality. This means the [format of the data can differ significantly](https://forum.figma.com/t/need-help-with-gradienttranform-matrix/26792) from that expected by the Plugin API.\n\nIn the future we would like to have a way of transforming between the REST API to the Plugin API. This will allow us to pull arbitrary Figma urls without having to open Figma Desktop first.\n\n## Other Formats 📄\n\n### SVG Export\n\nSVG is an industry standard, but the spec is very large and each [design editor only implements a subset of it](https://www.figma.com/blog/with-figmas-new-svg-exports-less-more/).\n\nFor that reason, when Figma exports to SVG it removes certain metadata. E.g. Text gets converted to a path instead of using the SVG `\u003cText\u003e` tag. This makes it harder for other design tools to work with.\n\n### OpenDesign\n\n[OpenDesign](http://opendesign.dev/) is an incredible initiative to create a uniform format we can share across design tools. The format is called Octopus. It supports most of the features of Figma, [https://opendesign.dev/docs/design-format-support](https://opendesign.dev/docs/design-format-support).\n\nParts of the stack like the render are not fully-open source, so sadly we couldn't simply extend their work yet. We hope to chat with their team and see what we can do.\n\n### Penpot\n\nPenpot is a fantastic editor trying to leverage SVG to work across design tools. However as mentioned SVG is not perfect and we need a specialized [import from Figma which is not yet ready](https://github.com/penpot/penpot/issues/2265).\n\n### .sketch\n\nWhile Figma build an importer for sketch files, the Sketch team has not build an importer for .fig files.\n\n### Framer\n\nFramer can import Figma Files through the REST API.\n\n## Contribution\n\nPlease feel free to fork the repo and create pull requests. If you find a bug report it, if you have ideas and want to have a discussion use the discussion tab 😁.\n\n## Special Thanks\n\n- Yuan Qing Lim for https://github.com/yuanqing/create-figma-plugin\n- Figma Plugin Helper Functions: https://github.com/figma-plugin-helper-functions/figma-plugin-helpers\n- Brian Lovin for https://github.com/brianlovin/figma-export-zip\n- Boiao Ch for cracking reading .fig files in: https://github.com/liaobinbin/fig-to-json\n\n# Other Interesting Projects\n\n- https://pavellaptev.github.io/JSON-from-Figma/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyagudaev%2Ffigma-to-json","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyagudaev%2Ffigma-to-json","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyagudaev%2Ffigma-to-json/lists"}