# VS Code Extension — Quick Start

# VS Code Extension — Quick Start

## Install

```bash
# From VS Code
ext install raymindai.mdfy-vscode

# Or search "mdfy" in the Extensions panel
```

## Getting Started

### 1. Preview any Markdown file

Open a `.md` file and press **Cmd+Shift+M** (Mac) or **Ctrl+Shift+M** (Windows/Linux).

The mdfy preview opens as a side panel with:
- Live rendered preview (WYSIWYG — you can click and edit)
- Formatting toolbar (bold, italic, headings, lists, code, tables)
- Document outline panel
- Dark/light theme that follows your VS Code settings

### 2. Publish to mdfy.cc

Press **Cmd+Alt+P** or right-click → "mdfy: Publish to mdfy.cc"

```
→ https://mdfy.cc/d/abc123  (copied to clipboard)
```

No account needed for basic publishing. The recipient sees a beautifully rendered document in their browser.

### 3. Cloud Sync

After publishing, your file stays in sync:

| Action | How |
|--------|-----|
| Push changes | Save the file (auto-push if enabled) |
| Pull changes | Command Palette → "mdfy: Pull from mdfy.cc" |
| View conflicts | VS Code diff editor opens automatically |

A `.mdfy.json` sidecar file is created next to your `.md`:

```json
{
  "docId": "abc123",
  "editToken": "eyJ...",
  "lastSyncedAt": "2026-04-27T..."
}
```

### 4. Sidebar

Click the **mdfy** icon in the Activity Bar to browse:

- **ALL** — every .md file in your workspace
- **SYNCED** — files published to mdfy.cc
- **LOCAL** — unpublished local files
- **CLOUD** — documents on mdfy.cc (pull to edit locally)

### 5. AI Tools

| Command | What it does |
|---------|-------------|
| AI Polish | Improve writing quality and clarity |
| AI Summary | Generate a concise summary |
| AI TL;DR | Extract key bullet points |
| AI Translate | Translate to any language |
| Ask AI to Edit | Describe changes in natural language |

## Keyboard Shortcuts

| Shortcut | Command |
|----------|---------|
| `Cmd+Shift+M` | Open WYSIWYG preview |
| `Cmd+Alt+P` | Publish to mdfy.cc |
| `Cmd+Alt+E` | Export (HTML, rich text) |

## Settings

| Setting | Default | Description |
|---------|---------|-------------|
| `mdfy.theme` | `auto` | Follows your VS Code theme |
| `mdfy.autoSync` | `false` | Auto-push on save |
| `mdfy.autoPreview` | `true` | Auto-open preview for .md files |
| `mdfy.syncInterval` | `30` | Polling interval (seconds) |