A Figma plugin for automatically generating documentation from your design files.
- 📝 Automatically documents all interactions in your Figma file
- 🎯 Groups interactions by their parent frames
- 🔍 Supports both page-wide and selection-based documentation
- 💬 Human-readable interaction descriptions
- 🎨 Clean, organized documentation layout
- ⚡ Efficient memory management and performance
- Clone the repository:
git clone https://github.com/floringheorghiu/figma-friday.git
cd figma-friday- Install dependencies:
npm install- Build the plugin:
npm run build- Import into Figma:
- Open Figma
- Go to Plugins > Development > Import plugin from manifest
- Select the
manifest.jsonfile from this project
- Run development server:
npm run dev- Run tests:
npm run test- Build for production:
npm run build-
Select the scope:
- Current Page: Documents all interactions on the current page
- Current Selection: Documents interactions only in selected frames/elements
-
Click "Generate Documentation" to create a new documentation frame
-
The plugin will create a new frame containing:
- Grouped interactions by parent frame
- Human-readable descriptions
- Interaction counts and details
See CONTRIBUTING.md for contribution guidelines.
See VERSION.md for detailed version history and changelog.