Skip to content

A smart Markdown editor with auto-formatting and perfect Word export. (智能 Markdown 编辑器,支持自动格式化与完美 Word 导出)

License

Notifications You must be signed in to change notification settings

Ma6302/papersmith-markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

📝 PaperSmith (Markdown 智能编辑器)

Python PyQt6 License Platform

PaperSmith 是一款专为中文写作和文档交付打造的 Markdown 编辑器。它解决了传统编辑器在导出 Word 时格式混乱的痛点,并提供了智能的格式规范功能,让您专注于写作,无需操心排版。

✨ 核心特性

1. 🚀 智能格式规范 (Smart Formatting)

告别繁琐的手动调整,软件会实时监控并修正您的文档结构:

  • 自动列表隔离:当列表与普通文本紧挨时,自动插入空行,防止渲染错误。
  • 自动表格隔离:智能检测表格边界,确保表格前后有正确的间距。
  • 嵌套保护:智能识别嵌套列表,不会破坏原有的缩进结构。

2. 📄 完美的 Word 导出

基于 Pandocpython-docx 的深度后处理技术:

  • 格式清洗:自动去除导出 Word 时产生的多余空行。
  • 列表优化:修复 Word 中列表缩进过大、符号错乱的问题。
  • 样式重置:自动将任务列表转换为美观的复选框样式,而非乱码符号。

3. 👁️ 丝滑的实时预览

  • 无闪烁更新:采用增量 DOM 更新技术,输入时预览区不会闪烁或跳动。
  • 双重同步
    • 滚动条跟随:预览区精准跟随编辑区滚动。
    • 状态记忆:记住您的同步开关设置。

4. 🧮 强大的数学公式

  • 内置 KaTeX 渲染引擎(使用国内极速 CDN)。
  • 完美支持行内公式 $E=mc^2$ 和块级公式 $$...$$
  • 解决了 Markdown 解析器对 LaTeX 下划线 _ 的误判问题。

🛠️ 安装与运行

方式一:下载安装包 (推荐)

适合普通用户,无需配置 Python 环境,开箱即用。

  1. 访问 Releases 页面。
  2. 下载最新的 .exe 安装包。
  3. 双击安装即可使用(已内置 Pandoc 环境)。

方式二:使用 Windows 终端 (源码运行)

适合开发者,需要电脑已安装 Python 和 Git。

  1. 克隆仓库 打开 PowerShell 或 CMD,输入以下命令:

    git clone https://github.com/Ma6302/papersmith-markdown-editor.git
    cd papersmith-markdown-editor
  2. 安装依赖

    pip install PyQt6 markdown pypandoc python-docx

    注意:源码运行模式下,您需要手动在系统环境变量中安装配置 pandoc

  3. 运行软件

    python main.py

📖 使用指南

  • 同步滚动:点击工具栏的 🔗 同步 按钮可开启/关闭预览区跟随。
  • 插入元素:工具栏提供了 H (标题), B (粗体), I (斜体), (表格), 🖼 (图片) 等快捷按钮。
  • 快捷保存:支持使用 F12 键快速唤起“另存为”对话框,保存文件更高效。
  • 导出文档:点击右上角的 💾 保存 按钮,选择 .docx.pdf 格式即可导出。

🔧 技术栈

  • GUI: PyQt6 + QWebEngine
  • Parser: Python-Markdown (with Custom Extensions)
  • Converter: Pandoc + python-docx
  • Math: KaTeX (via Staticfile CDN)

📄 开源协议

本项目基于 MIT 协议 开源。


Created with ❤️ by [Ma6302]

About

A smart Markdown editor with auto-formatting and perfect Word export. (智能 Markdown 编辑器,支持自动格式化与完美 Word 导出)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages