# 小仙笔记

**Repository Path**: conspicuous-c/xiaox-Markdown

## Basic Information

- **Project Name**: 小仙笔记
- **Description**: 小仙笔记是一款基于 Tauri 2 + Vue 3 构建的桌面 Markdown 编辑器，支持图片拖拽粘贴、本地存储、主题切换等功能。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-30
- **Last Updated**: 2026-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小仙笔记

一款简洁高效的本地 Markdown 笔记应用。

## 📖 产品介绍

小仙笔记是一款基于 Tauri 2 + Vue 3 构建的桌面 Markdown 编辑器，支持图片拖拽粘贴、本地存储、主题切换等功能。

## ✨ 主要功能

### 📝 Markdown 编辑

- 实时预览，所见即所得
- Milkdown/Crepe 编辑器内核
- 支持图片拖拽粘贴
- 自动保存到本地

### 📁 文件管理

- 新建、打开、编辑 Markdown 文件
- 自动备份，防止数据丢失
- 支持文件拖拽打开

### 🎨 主题支持

- 浅色/深色主题一键切换
- 系统主题自动同步
- 护眼模式

### ⌨️ 快捷键

| 功能     | 快捷键   |
| -------- | -------- |
| 保存文件 | Ctrl + S |
| 新建文件 | Ctrl + N |
| 打开文件 | Ctrl + O |

## 🛠️ 技术特性

- **跨平台**：目前支持 Windows
- **本地优先**：所有数据存储在本地，不上传云端
- **性能优异**：基于 Tauri，原生性能体验
- **安全可靠**：数据完全本地化，保护隐私

## 📋 系统要求

- Windows 10+
- 至少 20MB 磁盘空间

## 🚀 快速开始

### 开发模式

```bash
# 安装依赖
pnpm install

# 启动开发服务器
pnpm tauri dev
```

### 生产打包

```bash
# 构建前端
pnpm build

# 打包应用
pnpm tauri build
```

### 打包参数说明

```bash
# MSI 安装包（Windows 标准格式）
pnpm tauri build --bundler wix

# NSIS 安装包（EXE 安装向导）
pnpm tauri build --bundler nsis
```

## 📂 项目结构

```
tauri-app/
├── src/                    # 前端源码
│   ├── pages/              # 页面组件
│   ├── components/         # 可复用组件
│   ├── services/           # 服务层（HTTP、Tauri 调用）
│   ├── stores/             # 状态管理
│   ├── styles/             # 样式文件
│   └── locales/            # 国际化文件
├── src-tauri/              # Tauri/Rust 后端
│   ├── src/               # Rust 源码
│   ├── capabilities/      # 权限配置
│   └── icons/             # 应用图标
└── dist/                   # 构建产物
```

## 🔧 配置说明

### 主题配置

主题配置文件位于 `src/stores/settings.js`，支持以下选项：

- `theme`: "light" | "dark"
- `locale`: "zh-CN" | "en-US"

### 快捷键自定义

快捷键配置位于 `src/components/settings/ShortcutSettings.vue`。

## 📝 更新日志

### v0.1.0 (2025-02)

- ✨ 初始版本发布
- 📝 Markdown 编辑功能
- 🖼️ 图片拖拽粘贴支持
- 🎨 主题切换功能
- 📁 文件管理功能

## 🤝 贡献指南

欢迎提交 Issue 和 Pull Request。

## 📄 许可证

MIT License

## 📧 联系方式

如有问题，请提交 Issue 反馈。