# markdown

**Repository Path**: self-improve/markdown

## Basic Information

- **Project Name**: markdown
- **Description**: markdown工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown 转 PDF/HTML 工具

## 项目概述

**MarkFlow** 是一款基于 Electron 的跨平台（Windows、macOS、Linux）Markdown 编辑器与转换工具，专注于提供专业的 Markdown 编辑体验和强大的文档导出功能。

### 🤖 关于项目开发

本项目完全由 AI 辅助开发完成。完整的开发过程、技术选型讨论、功能实现细节等与 AI 的聊天记录都保存在 [`Ai聊天记录`](./docs/chat-histories/) 文件夹中，记录了从项目想法到最终实现的完整过程。这些记录对于理解项目开发思路、学习 AI 辅助开发流程具有重要参考价值。

## 项目价值

### 🎯 为什么选择 MarkFlow？

MarkFlow 旨在成为 **Typora 的开源替代方案**，为需要专业 Markdown 编辑和文档转换功能的用户提供免费、开源的选择。

#### ✨ 核心优势

- **🆓 完全免费开源** - 无需付费，代码完全开放，可自由使用和定制
- **📦 强大的批量转换** - 支持批量将多个 Markdown 文件转换为 PDF、HTML、DOCX 格式
- **🎨 丰富的导出格式** - 支持导出为 PDF、HTML、DOCX 等多种格式
- **⚡ 实时预览** - 所见即所得的编辑体验，支持分屏预览和实时渲染
- **🎨 主题定制** - 内置多种代码高亮主题和应用主题，支持自定义 CSS 样式
- **📐 数学公式支持** - 基于 KaTeX 的数学公式渲染，支持复杂的数学表达式
- **💻 跨平台支持** - 支持 Windows、macOS 和 Linux，界面统一美观

#### 🆚 与 Typora 对比

| 特性 | MarkFlow | Typora |
|------|----------|--------|
| **价格** | 🆓 完全免费 | 💰 收费（$14.99） |
| **开源** | ✅ 完全开源 | ❌ 闭源 |
| **批量转换** | ✅ 支持批量转换多个文件 | ❌ 不支持批量转换 |
| **导出格式** | ✅ PDF、HTML、DOCX | ✅ PDF、HTML、EPUB、Word |
| **实时预览** | ✅ 支持 | ✅ 支持 |
| **代码高亮** | ✅ 支持（highlight.js） | ✅ 支持 |
| **数学公式** | ✅ 支持（KaTeX） | ✅ 支持 |
| **主题定制** | ✅ 支持自定义 CSS | ✅ 支持主题 |
| **跨平台** | ✅ Windows、macOS、Linux | ✅ Windows、macOS、Linux |
| **可定制性** | ✅ 开源可深度定制 | ❌ 闭源无法定制 |

#### 🎁 独特功能

1. **批量文档处理**
   - 一次性转换多个 Markdown 文件
   - 支持批量导出为 PDF、HTML 格式
   - 进度跟踪和错误处理

2. **灵活的样式定制**
   - 支持自定义 CSS 样式
   - 多种代码高亮主题可选
   - 支持明暗主题切换

3. **专业的导出选项**
   - PDF 导出支持自定义页眉页脚
   - HTML 导出支持独立文件或内嵌样式
   - DOCX 导出支持 Word 文档格式

4. **开发者友好**
   - 完全开源，可自由修改和扩展
   - 基于现代技术栈（Electron + React + TypeScript）
   - 代码结构清晰，易于维护

#### 💡 适用场景

- 📝 **技术文档编写** - 适合编写技术文档、API 文档、项目说明等
- 📚 **学术论文** - 支持数学公式，适合学术写作
- 📄 **报告生成** - 批量转换功能适合批量生成报告
- 🔧 **开发者工具** - 开源特性适合集成到开发工作流中
- 🎓 **学习研究** - 免费开源，适合学习和研究使用

### 📋 使用限制

为保证稳定运行与内存可控，应用对以下行为设定了上限（可在代码中调整常量）：

| 限制项 | 默认值 | 说明 |
|--------|--------|------|
| **最大同时打开文件数** | 30 | 超过时提示「请先关闭部分文件再打开新文件」，不追加新文件。 |
| **目录文件列表展示** | 前 500 条 | 打开包含大量文件的目录时，侧栏仅展示前 500 个文件，并显示「已显示前 500 个，共 N 个」。 |
| **单次批量转换文件数** | 50 | 批量转换时若选择超过 50 个文件，仅保留前 50 个并提示。 |

## 下载

### 网盘下载（夸克）

📥 **夸克网盘**：<https://pan.quark.cn/s/d9cf5f87e69c>  
使用夸克 APP 时，可复制 `/~f6343AHp2S~:/` 打开获取。

网盘内提供 Windows（安装版/便携版）、macOS（x64/arm64）、Linux（AppImage/deb）等各平台安装包。

> 💡 **提示**：打包说明与文件列表请查看 [downloads/README.md](./downloads/README.md)

> 💡 **提示**：技术栈、开发环境设置和项目结构请查看 [开发指南.md](./开发指南.md)

> 💡 **提示**：详细的技术选型方案请查看 [技术选型方案.md](./技术选型方案.md)

## 许可证

本项目采用 [MIT 许可证](LICENSE)。

Copyright (c) 2026 BruceLiu

MIT 许可证是一个宽松的开源许可证，允许用户自由使用、修改、分发和商业化本项目，只需保留版权声明和许可证声明即可。