基于 Java 8 + JavaFX 构建的桌面 Markdown 阅读与编辑工具,追求类 Typora 的沉浸式阅读体验。
实时预览 — 左侧编辑 Markdown 源码,右侧 WebView 实时渲染 HTML 预览,250ms 防抖联动更新。
三种视图模式 — 分栏模式、纯编辑模式、纯阅读模式,Ctrl+1/2/3 一键切换,适应不同使用场景。
四套精美主题 — GitHub(经典浅色)、Notion(柔和现代)、Dracula(深色护眼)、Solarized(暖色护眼),Ctrl+T 循环切换。
侧栏导航 — 文件树浏览目录中的 .md 文件,大纲视图自动提取标题层级,支持快速跳转。
丰富的快捷键 — Ctrl+B 加粗、Ctrl+I 斜体、Ctrl+K 插入链接、Ctrl+S 保存、Ctrl+E 循环视图模式。
拖拽打开 — 直接拖拽 .md 文件或文件夹到窗口即可打开。
GFM 扩展语法 — 基于 commonmark-java,支持表格、任务列表、删除线、自动链接、标题锚点等。
启动后默认展示一份包含所有 Markdown 语法示例的欢迎文档,涵盖标题、列表、代码块、表格、引用、任务列表等元素的渲染效果。
- Java 8(JDK 1.8,需包含 JavaFX,推荐使用 Oracle JDK 8)
- Maven 3.6+
# 克隆仓库
git clone https://github.com/XIURongYao/markdown-reader-java.git
cd markdown-reader-java
# 编译打包
mvn clean package -DskipTests
# 运行
java -jar target/markdown-reader-1.0.0.jar也可以在命令行直接打开指定文件:
java -jar target/markdown-reader-1.0.0.jar /path/to/your/file.md| 快捷键 | 功能 |
|---|---|
Ctrl+O |
打开文件 |
Ctrl+S |
保存文件 |
Ctrl+B |
加粗 |
Ctrl+I |
斜体 |
Ctrl+K |
插入链接 |
Ctrl+T |
切换主题 |
Ctrl+E |
循环视图模式 |
Ctrl+1 |
分栏模式 |
Ctrl+2 |
编辑模式 |
Ctrl+3 |
阅读模式 |
src/main/
├── java/com/mdreader/
│ ├── App.java # 应用入口
│ ├── controller/
│ │ └── MainController.java # 主窗口控制器
│ └── service/
│ ├── MarkdownService.java # Markdown 解析 + 主题管理
│ └── FileService.java # 文件读写 + 目录树
└── resources/
├── fxml/main.fxml # 主窗口布局
└── css/
├── app.css # 应用 UI 样式
└── themes/ # 预览主题
├── github.css
├── notion.css
├── dracula.css
└── solarized.css
| 组件 | 技术 |
|---|---|
| UI 框架 | JavaFX 8 |
| Markdown 解析 | commonmark-java 0.21.0 |
| HTML 渲染 | JavaFX WebView (WebKit) |
| 扩展语法 | gfm-tables / gfm-strikethrough / task-list / autolink / heading-anchor |
| 构建工具 | Maven + maven-shade-plugin |
MIT License
开发者:Qoder
联系方式:dashuizhuyu@qq.com