@@ -13,6 +13,14 @@ figdeck is a tool that automatically generates Figma Slides from Markdown files.
1313
1414## Installation
1515
16+ ### Figma Plugin
17+
18+ Install the figdeck plugin from Figma Community:
19+
20+ ** [ figdeck - Figma Community] ( https://www.figma.com/community/plugin/1577342026252824260/figdeck ) **
21+
22+ ### CLI
23+
1624``` bash
1725# Install globally
1826npm install -g figdeck
@@ -35,6 +43,9 @@ npx figdeck slides.md
3543
3644### Method 1: WebSocket Connection (Live Reload Support)
3745
46+ > [ !NOTE]
47+ > WebSocket connection requires ** Figma Desktop app** . The web browser version cannot connect to localhost due to security restrictions.
48+
3849``` bash
3950# Start WebSocket server with CLI (watch mode enabled by default)
4051npx figdeck your-slides.md
@@ -46,18 +57,18 @@ npx figdeck serve your-slides.md
4657npx figdeck your-slides.md --no-watch
4758```
4859
49- 1 . Load the plugin in development mode in Figma
60+ 1 . Open the figdeck plugin in Figma Desktop
50612 . Connect to CLI from the "WebSocket" tab in the Plugin
51623 . Slides are automatically generated
5263
53- ### Method 2: JSON Import (No CLI Required )
64+ ### Method 2: JSON Import (Works on Desktop & Web )
5465
5566``` bash
5667# Output JSON from Markdown
5768npx figdeck build your-slides.md -o slides.json
5869```
5970
60- 1 . Load the plugin in development mode in Figma
71+ 1 . Open the figdeck plugin in Figma
61722 . Select the "Import JSON" tab in the Plugin
62733 . Paste JSON or select a file to load
63744 . Click "Generate Slides" to create slides
0 commit comments