# md2card

**Repository Path**: lucas9/md2card

## Basic Information

- **Project Name**: md2card
- **Description**: Markdown转精美卡片工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 2
- **Created**: 2025-04-09
- **Last Updated**: 2025-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MD2Card - Markdown转精美卡片工具

<p align="center">
  <img src="./public/logo.svg" alt="MD2Card Logo" width="120" height="120">
</p>

## 📝 项目介绍

MD2Card 是一个将 Markdown 内容转换为精美卡片的工具，支持多种风格和自定义设置。无论是制作知识卡片、分享卡片还是学习笔记，MD2Card 都能帮助您快速创建美观的内容展示。

<p align="center">
  <img src="./screenshots/view.png" alt="MD2Card 编辑器界面" width="800">
</p>

## ✨ 主要特性

- **强大的 Markdown 编辑器**：基于 Vditor 提供专业的 Markdown 编辑体验
- **多种卡片风格**：内置多种精美卡片主题，满足不同场景需求
- **自定义尺寸**：支持自定义卡片尺寸和比例，适应各种展示需求
- **内容自动拆分**：支持按三横线分隔符自动拆分内容为多张卡片
- **实时预览**：编辑的同时实时预览卡片效果
- **一键导出**：支持将卡片导出为高质量 PNG 图片，多卡片自动打包为 ZIP
- **全屏预览**：支持全屏模式预览卡片效果

## 🚀 安装与使用

### 安装依赖

```bash
npm install
```

### 开发模式

```bash
npm run serve
```

### 构建生产版本

```bash
npm run build
```

## 💡 使用指南

1. 点击首页的「开始创建」按钮进入编辑器
2. 在左侧 Markdown 编辑器中编写内容
3. 右侧实时预览卡片效果
4. 可以通过右侧面板调整卡片样式、尺寸和比例
5. 使用「---」分隔符可以将内容拆分为多张卡片
6. 点击「导出 PNG」按钮导出卡片图片

### 使用示例

```markdown
# 我的学习笔记

这是使用 MD2Card 创建的学习笔记卡片。

## 重点内容

- 支持 Markdown 语法
- 可以添加**粗体**、*斜体*等格式
- 支持多级标题和列表

---

# 第二张卡片

使用三个连字符(---)可以将内容分割成多张卡片。

- 每张卡片都可以单独导出（待实现）
- 也可以一次性导出所有卡片
```

### Markdown 语法参考

- [基础语法](https://ld246.com/article/1583129520165)
- [扩展语法](https://ld246.com/article/1583305480675)
- [速查手册](https://ld246.com/article/1583308420519)

## 🔧 技术栈

- Vue 3 - 前端框架
- TypeScript - 类型支持
- Vditor - Markdown 编辑器
- Element Plus - UI 组件库
- JSZip - 多卡片打包

## 📄 许可证

[MIT](LICENSE)

## 🤝 贡献指南

欢迎提交 Issue 或 Pull Request 来帮助改进这个项目！

1. Fork 本仓库
2. 创建您的特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交您的更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 打开一个 Pull Request