# air-markdown

**Repository Path**: air3132268206/air-markdown

## Basic Information

- **Project Name**: air-markdown
- **Description**: markdown 编辑器
- **Primary Language**: Rust
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-24
- **Last Updated**: 2026-09-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Air Markdown

一款轻快、优雅的桌面 Markdown 编辑器 —— Tauri 2 + React + TipTap，Windows 原生体验，安装包仅 ~5 MB。

> 定位：对标 Typora 的"所见即所得"写作体验 + Obsidian 的效率工具属性（全局搜索 / 版本历史 / 大纲 / 演示），
> 同时保持"文件就是普通 .md"的开放性与极速启动。

## 界面

| 所见即所得 | 实时预览 |
| --- | --- |
| ![wysiwyg](docs/screenshots/smoke_wysiwyg.png) | ![preview](docs/screenshots/smoke_preview.png) |
| **源码模式** | **深色主题** |
| ![source](docs/screenshots/smoke_source.png) | ![dark](docs/screenshots/smoke_dark.png) |

## 功能特性

### 编辑

- **三视图**：所见即所得（TipTap）/ 源码（CodeMirror 6）/ 实时预览 / 分栏，`Ctrl+1~4` 秒切
- **Markdown 输入即转换**：`**粗**` `# 标题` `- [ ] 任务` `|a|b|` 表格速建、`/` 斜杠菜单插入一切
- **表格编辑**：单元格 Tab/Shift+Tab 跳格、末格自动加行、浮动行列工具栏（合并/拆分/表头）
- **扩展语法**：数学公式（KaTeX）、Mermaid 流程图/时序图（内联渲染可拖拽平移）、定义列表、脚注（点击上标编辑）、任务列表、代码高亮（100+ 语言）
- **HTML / Word 粘贴清洗**：自动剥离样式垃圾，保留语义结构
- 图片粘贴/拖拽自动存入文档同级 `assets/`（引用短相对路径，不产生 base64 巨串）
- 查找替换、打字机/专注/Zen 模式、崩溃自动恢复（swap）、字数目标

### 效率

- **全局跨文件搜索**（`Ctrl+Shift+F`）+ 快速打开（`Ctrl+E`）+ 命令面板（`Ctrl+P`）
- **版本历史**：每次保存自动快照，diff 预览、一键恢复（标签右键菜单 / 命令面板）
- **大纲拖拽**：侧栏拖动标题即移动整个章节
- **演示模式**（`Ctrl+Shift+P`）：按 `---` 分页全屏放映，键盘翻页
- 多标签、多窗口（工作区按窗口独立记忆）、文件关联（双击 .md 直接打开）、深色/浅色/跟随系统、自定义强调色

### 导出

- 导出 HTML（自包含单文件：图片内嵌、图表转 SVG）
- **一键直出 PDF**（Edge 无头渲染，智能分页：代码块/表格不跨页）或走系统打印对话框
- 可选"一级标题另起页"，A4 页边距

## 下载与安装

从 [Releases](../../releases) 下载 `Air Markdown_x.y.z_x64-setup.exe`，双击安装（支持中文安装界面）。
Win10/11 x64；若系统缺少 WebView2 运行时，安装器会自动引导安装。

## 快捷键

按 `F1` 查看完整速查表。常用：

| 键 | 功能 | 键 | 功能 |
| --- | --- | --- | --- |
| `Ctrl+N / Ctrl+Shift+N` | 新建文档 / 新建窗口 | `Ctrl+S` | 保存 |
| `Ctrl+E` | 快速打开 | `Ctrl+Shift+F` | 全局搜索 |
| `Ctrl+P` | 命令面板 | `Ctrl+Shift+P` | 演示模式 |
| `Ctrl+1~4` | 分栏/所见即所得/源码/预览 | `F8 / F9 / F11` | 打字机 / 专注 / Zen |
| `F1` | 速查表 | `Ctrl+W` | 关闭标签 |

## 开发

```powershell
npm install        # 依赖安装
npm run tauri dev  # 开发模式（Vite:1420 + Rust 热编译）
npm run test       # 单元测试（vitest）
npm run tauri build  # 出 NSIS 安装包
```

环境要求（Node 18+ / Rust stable / VS Build Tools C++ 桌面负载）与详细排障见
[docs/startup-build-guide.md](docs/startup-build-guide.md)。

### 技术栈与结构

Tauri 2（Rust 文件 IO / 搜索 / 历史快照 / 图片落盘）· React 18 · TipTap 2（ProseMirror）·
CodeMirror 6 · markdown-it · Zustand · KaTeX · Mermaid · Vitest

```
src/
├── editor/    # TipTap 扩展（表格工具栏/脚注/定义列表/斜杠菜单…）
├── source/    # CodeMirror 源码模式（补全/图片徽标）
├── preview/   # 预览面板
├── shell/     # 标题栏/侧栏/命令面板/全局搜索/历史对话框/演示模式
├── lib/       # 纯函数层（markdown/搜索/diff/导出/粘贴清洗）
└── stores/    # tabs/settings/workspace（Zustand）
src-tauri/src/ # files.rs(IO/搜索/历史/图片) windows.rs pdf.rs(Edge 无头导出)
```

## 版本策略

语义化版本；功能批次进 minor，缺陷修复进 patch。发布记录见 [Releases](../../releases)
与 `docs/release-notes-*.md`。