# mark-tau

**Repository Path**: atnx/mark-tau

## Basic Information

- **Project Name**: mark-tau
- **Description**: 一款基于 Tauri + Vue 3 的 Markdown 即时渲染编辑器。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-07
- **Last Updated**: 2026-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MarkTau

一款基于 Tauri + Vue 3 的 Markdown 即时渲染编辑器。

**Mark** = Markdown，**Tau** = Tauri。用 Tauri 做一个轻量、美观的 Markdown 编辑器。

![Mark-Tau 主界面](public/1.png)
![Mark-Tau 编辑界面](public/2.png)

## 下载安装

[下载 Windows 安装包 (v0.1.0)](https://gitee.com/atnx/mark-tau/releases/download/v0.1.0/MarkTau_0.1.0_x64_en-US.msi)

## 特性

- **即时渲染** — 基于 Vditor IR 模式，输入 Markdown 即刻看到渲染结果
- **格式工具栏** — 加粗、斜体、标题、列表、代码块、链接、图片一键插入
- **表格操作** — 浮动工具条，点击表格即可添加行/列
- **深色/浅色主题** — 一键切换，编辑器主题同步跟随
- **中文界面** — 菜单、提示、快捷键提示全部中文化
- **文件管理** — 新建、打开、保存、另存为，快捷键 Ctrl+N / Ctrl+O / Ctrl+S
- **状态栏** — 实时显示文件名、修改状态、字数统计
- **自定义标题栏** — 无边框窗口，菜单栏集成，支持拖拽和双击最大化
- **代码高亮** — 行号显示，深色模式用 Dracula 主题
- **图片粘贴** — 直接粘贴图片到编辑器，自动转为 Markdown 图片语法
- **Emoji 输入** — 输入 `:` 触发 Emoji 提示列表

## 技术栈

| 层 | 技术 |
|---|---|
| 前端 | Vue 3 (Composition API) · Vite |
| 编辑器 | Vditor (即时渲染) |
| 后端 | Tauri 2 · Rust |
| 样式 | 原生 CSS，无第三方 UI 库 |

## 快速开始

```bash
# 1. 安装 Node.js + pnpm
#    https://nodejs.org/

# 2. 安装 Rust
#    https://rustup.rs/

# 3. Windows 用户：安装 Visual Studio Build Tools 2022
#    勾选"使用 C++ 的桌面开发"工作负载
#    https://visualstudio.microsoft.com/visual-cpp-build-tools/

# 4. 安装依赖 & 启动开发模式
pnpm install
pnpm tauri dev
```

> Windows 构建遇到问题？详见 [Windows 构建详解](docs/windows-setup.md)，包含 MSVC 链接器、Windows SDK 和常见冲突的解释。

> macOS 用户只需安装 Xcode Command Line Tools：`xcode-select --install`

## 跨平台打包

Tauri 支持跨平台但**不支持交叉打包**（在 Windows 上打不出 macOS 版）：

| 平台 | 格式 | 需要在对应平台运行 |
|------|------|------|
| Windows | `.msi` / `.exe`（NSIS） | Windows |
| macOS | `.dmg` | Mac |
| Linux | `.deb` / `.AppImage` | Linux |

```bash
pnpm tauri build
```

没有 Mac/Linux 机器？用 [GitHub Actions](https://github.com/features/actions) 配置多平台 CI，免费额度足够个人项目。

## 项目结构

```
src/
├── components/       # Vue 组件
│   ├── TitleBar.vue      # 自定义标题栏 + 菜单
│   ├── Toolbar.vue       # 格式工具栏
│   ├── VditorPanel.vue   # Vditor 编辑器面板
│   ├── StatusBar.vue     # 状态栏
├── composables/      # 组合式函数（响应式状态）
│   ├── useEditor.js      # 编辑器内容 + 字数统计
│   ├── useFileStore.js   # 文件打开/保存状态
│   ├── useTheme.js       # 主题切换
├── main.js           # 入口
└── App.vue           # 根组件
```

开发规范详见 [CLAUDE.md](CLAUDE.md)。

## 贡献

欢迎 PR！请先阅读 [CLAUDE.md](CLAUDE.md) 了解开发规范（Composition API、命名规则、文件结构等）。

## License

[MIT](LICENSE)