Skip to content

Commit bcfd046

Browse files
committed
docs: update README to include Figma plugin installation instructions and clarify WebSocket connection requirements
1 parent d804540 commit bcfd046

2 files changed

Lines changed: 28 additions & 6 deletions

File tree

README.ja.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ figdeck は Markdown ファイルから Figma Slides を自動生成するツー
88

99
## インストール
1010

11+
### Figma Plugin
12+
13+
Figma Community から figdeck プラグインをインストール:
14+
15+
**[figdeck - Figma Community](https://www.figma.com/community/plugin/1577342026252824260/figdeck)**
16+
17+
### CLI
18+
1119
```bash
1220
# グローバルインストール
1321
npm install -g figdeck
@@ -20,6 +28,9 @@ npx figdeck your-slides.md
2028

2129
### 方法 1: WebSocket 連携(ライブリロード対応)
2230

31+
> [!NOTE]
32+
> WebSocket 接続には **Figma デスクトップアプリ** が必要です。Web ブラウザ版はセキュリティ制約により localhost に接続できません。
33+
2334
```bash
2435
# CLI で WebSocket サーバーを起動(ウォッチモードがデフォルトで有効)
2536
npx figdeck your-slides.md
@@ -31,18 +42,18 @@ npx figdeck serve your-slides.md
3142
npx figdeck your-slides.md --no-watch
3243
```
3344

34-
1. Figma でプラグインを開発モードで読み込み
45+
1. Figma デスクトップアプリで figdeck プラグインを開く
3546
2. Plugin の「WebSocket」タブで CLI に接続
3647
3. スライドが自動生成される
3748

38-
### 方法 2: JSON インポート(CLI 不要
49+
### 方法 2: JSON インポート(デスクトップ・Web 両対応
3950

4051
```bash
4152
# Markdown から JSON を出力
4253
npx figdeck build your-slides.md -o slides.json
4354
```
4455

45-
1. Figma でプラグインを開発モードで読み込み
56+
1. Figma で figdeck プラグインを開く
4657
2. Plugin の「Import JSON」タブを選択
4758
3. JSON をペーストするか、ファイルを選択して読み込み
4859
4. 「Generate Slides」でスライドを生成

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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
1826
npm 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)
4051
npx figdeck your-slides.md
@@ -46,18 +57,18 @@ npx figdeck serve your-slides.md
4657
npx 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
5061
2. Connect to CLI from the "WebSocket" tab in the Plugin
5162
3. 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
5768
npx 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
6172
2. Select the "Import JSON" tab in the Plugin
6273
3. Paste JSON or select a file to load
6374
4. Click "Generate Slides" to create slides

0 commit comments

Comments
 (0)