Skip to content

Commit 44d8a51

Browse files
committed
fix: update documentation links and improve CLI command descriptions
1 parent e07461a commit 44d8a51

9 files changed

Lines changed: 48 additions & 36 deletions

File tree

‎examples/callouts.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This is a CAUTION callout. Use it for destructive actions or security-sensitive
5454
Callouts support inline formatting.
5555

5656
:::tip
57-
Use `--secret` for **authentication** when using `--allow-remote`. See the [documentation](https://figdeck.vercel.app) for details.
57+
Use `--secret` for **authentication** when using `--allow-remote`. See the [documentation](https://figdeck.7nohe.dev) for details.
5858
:::
5959

6060
---

‎packages/docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Both English and Japanese versions are available.
7878

7979
## Deployment
8080

81-
The documentation site is deployed to Vercel at [https://figdeck.vercel.app](https://figdeck.vercel.app).
81+
The documentation site is deployed at [https://figdeck.7nohe.dev](https://figdeck.7nohe.dev).
8282

8383
## Learn More
8484

‎packages/docs/src/consts.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ export const SITE = {
33
title: "figdeck",
44
description:
55
"Convert Markdown files into Figma Slides with a CLI + Figma Plugin",
6-
url: "https://figdeck.vercel.app",
7-
ogImage: "https://figdeck.vercel.app/og-image.png",
6+
url: "https://figdeck.7nohe.dev",
7+
ogImage: "https://figdeck.7nohe.dev/og-image.png",
88
ogImageWidth: 1200,
99
ogImageHeight: 630,
1010
} as const;

‎packages/docs/src/content/docs/en/api-reference.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ figdeck build slides.md | jq '.[] | .title'
8585

8686
#### `serve` - WebSocket Server
8787

88-
Starts a WebSocket server and waits for Plugin connections.
88+
Starts a WebSocket server and waits for Plugin connections. Watch mode is enabled by default.
8989

9090
```bash
9191
figdeck serve <file> [options]
@@ -97,25 +97,31 @@ figdeck serve <file> [options]
9797

9898
| Option | Description | Default |
9999
|--------|-------------|---------|
100-
| `--host <host>` | WebSocket host | `localhost` |
100+
| `--host <host>` | WebSocket host | `127.0.0.1` |
101101
| `-p, --port <port>` | WebSocket port | `4141` |
102-
| `-w, --watch` | Watch file changes and auto-update | `false` |
102+
| `--no-watch` | Disable watching for file changes | - |
103+
| `--allow-remote` | Allow binding to non-loopback hosts | - |
104+
| `--secret <secret>` | Require authentication with this secret | - |
105+
| `--no-auth` | Disable authentication (not recommended for remote) | - |
103106
| `-h, --help` | Show help | - |
104107

105108
**Examples:**
106109

107110
```bash
108-
# Basic usage
111+
# Basic usage (watch mode enabled by default)
109112
figdeck serve slides.md
110113

111114
# Specify port
112115
figdeck serve slides.md --port 8080
113116

114-
# Specify host (allow external connections)
115-
figdeck serve slides.md --host 0.0.0.0
117+
# Disable watch mode
118+
figdeck serve slides.md --no-watch
116119

117-
# File watch mode (auto-resend on changes)
118-
figdeck serve slides.md -w
120+
# Allow external connections (requires --allow-remote)
121+
figdeck serve slides.md --host 0.0.0.0 --allow-remote
122+
123+
# Remote access with authentication
124+
figdeck serve slides.md --host 0.0.0.0 --allow-remote --secret my-secret
119125
```
120126

121127
## YAML Frontmatter

‎packages/docs/src/content/docs/en/getting-started/installation.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Download from: [figma.com/downloads](https://www.figma.com/downloads/)
1919

2020
### Node.js
2121

22-
Node.js 20 or later is required to run the CLI.
22+
Node.js LTS or later is required to run the CLI.
2323

2424
Download from: [nodejs.org](https://nodejs.org/)
2525

‎packages/docs/src/content/docs/en/release-notes.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,22 @@ See [VSCode Extension Documentation](/en/vscode-extension) for details.
5757
The `figdeck init` command can now generate rule files for AI agents.
5858

5959
**Supported AI Agents:**
60-
- **Claude Code**: Generates `CLAUDE.md` file
60+
- **Claude Code**: Generates `.claude/rules/figdeck.md` file
6161
- **Cursor**: Generates `.cursor/rules/figdeck.mdc` file
62-
- **GitHub Copilot**: Generates `.github/copilot-instructions.md` file
62+
- **GitHub Copilot**: Generates `.github/instructions/figdeck.instructions.md` file
6363

6464
**Examples:**
6565
```bash
6666
# Generate rules for all AI agents
67-
figdeck init --agents
67+
figdeck init --ai-rules
6868

6969
# Generate rules for a specific agent only
70-
figdeck init --agents claude
71-
figdeck init --agents cursor
72-
figdeck init --agents copilot
70+
figdeck init --ai-rules claude
71+
figdeck init --ai-rules cursor
72+
figdeck init --ai-rules copilot
7373

7474
# Specify multiple agents
75-
figdeck init --agents claude,cursor
75+
figdeck init --ai-rules claude,cursor
7676
```
7777

7878
This enables AI agents to understand figdeck's Markdown syntax and provide more accurate code completions and suggestions.

‎packages/docs/src/content/docs/ja/api-reference.md‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ figdeck build slides.md | jq '.[] | .title'
8585

8686
#### `serve` - WebSocket サーバー
8787

88-
WebSocket サーバーを起動して Plugin からの接続を待機します。
88+
WebSocket サーバーを起動して Plugin からの接続を待機します。ファイル監視モードはデフォルトで有効です。
8989

9090
```bash
9191
figdeck serve <file> [options]
@@ -97,25 +97,31 @@ figdeck serve <file> [options]
9797

9898
| オプション | 説明 | デフォルト |
9999
|------------|------|-----------|
100-
| `--host <host>` | WebSocket ホスト | `localhost` |
100+
| `--host <host>` | WebSocket ホスト | `127.0.0.1` |
101101
| `-p, --port <port>` | WebSocket ポート | `4141` |
102-
| `-w, --watch` | ファイル変更を監視して自動更新 | `false` |
102+
| `--no-watch` | ファイル監視を無効化 | - |
103+
| `--allow-remote` | 非ループバックホストへのバインドを許可 | - |
104+
| `--secret <secret>` | このシークレットで認証を要求 | - |
105+
| `--no-auth` | 認証を無効化(リモート接続時は非推奨) | - |
103106
| `-h, --help` | ヘルプ表示 | - |
104107

105108
**例:**
106109

107110
```bash
108-
# 基本的な使用
111+
# 基本的な使用(ファイル監視モードはデフォルトで有効)
109112
figdeck serve slides.md
110113

111114
# ポート指定
112115
figdeck serve slides.md --port 8080
113116

114-
# ホスト指定(外部からの接続を許可)
115-
figdeck serve slides.md --host 0.0.0.0
117+
# ファイル監視を無効化
118+
figdeck serve slides.md --no-watch
116119

117-
# ファイル監視モード(変更時に自動再送信)
118-
figdeck serve slides.md -w
120+
# 外部からの接続を許可(--allow-remote が必要)
121+
figdeck serve slides.md --host 0.0.0.0 --allow-remote
122+
123+
# リモートアクセス + 認証
124+
figdeck serve slides.md --host 0.0.0.0 --allow-remote --secret my-secret
119125
```
120126

121127
## YAML Frontmatter

‎packages/docs/src/content/docs/ja/getting-started/installation.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ figdeck は **Figma デスクトップアプリ** でのみ動作します。ブ
1919

2020
### Node.js
2121

22-
CLI を実行するには Node.js 20 以降が必要です。
22+
CLI を実行するには Node.js LTS 以降が必要です。
2323

2424
ダウンロード: [nodejs.org](https://nodejs.org/)
2525

‎packages/docs/src/content/docs/ja/release-notes.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,22 @@ figdeck 専用の VSCode 拡張機能を追加しました。Markdown スライ
5757
`figdeck init` コマンドで AI エージェント用のルールファイルを生成できるようになりました。
5858

5959
**対応 AI エージェント:**
60-
- **Claude Code**: `CLAUDE.md` ファイルを生成
60+
- **Claude Code**: `.claude/rules/figdeck.md` ファイルを生成
6161
- **Cursor**: `.cursor/rules/figdeck.mdc` ファイルを生成
62-
- **GitHub Copilot**: `.github/copilot-instructions.md` ファイルを生成
62+
- **GitHub Copilot**: `.github/instructions/figdeck.instructions.md` ファイルを生成
6363

6464
**使用例:**
6565
```bash
6666
# すべての AI エージェント用ルールを生成
67-
figdeck init --agents
67+
figdeck init --ai-rules
6868

6969
# 特定のエージェント用ルールのみ生成
70-
figdeck init --agents claude
71-
figdeck init --agents cursor
72-
figdeck init --agents copilot
70+
figdeck init --ai-rules claude
71+
figdeck init --ai-rules cursor
72+
figdeck init --ai-rules copilot
7373

7474
# 複数のエージェントを指定
75-
figdeck init --agents claude,cursor
75+
figdeck init --ai-rules claude,cursor
7676
```
7777

7878
これにより、AI エージェントが figdeck の Markdown 構文を理解し、より正確なコード補完や提案を行えるようになります。

0 commit comments

Comments
 (0)