@primer/figma-library-docgen

Figma Docgen

Figma Docgen is a tool for extracting component metadata from Figma libraries. This tool is useful for documenting and analyzing Figma libraries.

Installation

To use Figma Docgen, you need to have npm installed. Then run the following command to install Figma Docgen:

npm i @primer/figma-library-docgen

Usage

docgen {{FIGMA_LIBRARY_ID}} --figmaToken {{PERSONAL_ACCESS_TOKEN}}

Figma library id

To use Figma Docgen, you need to pass a Figma library id. You can find the library id by going to the Figma library and copying the id from the URL.

Personal access token

You'll need a Figma personal access token.

Options

  --help               Show help                                       
  --version            Show version number
  --output             File path to output the generated JSON to        
  --figmaToken         Figma API personal access token                
  --downloadImages     Download component image thumbnails to disk
  --downloadImagesDir  Directory path for downloaded component images
  --showWarnings       Log warnings for missing component thumbnails