# markdown-assistant

**Repository Path**: caoshx2049/markdown-assistant

## Basic Information

- **Project Name**: markdown-assistant
- **Description**: Markdown Assistant是一款用JavaFX写的Markdown编辑器，基于Markdown Writer FX 做了一些定制化修改，添加了一些功能
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/Metora/markdown-assistant
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-01-30
- **Last Updated**: 2025-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Markdown, Java, Javafx, pdf, docx

## README

# Markdown Assistant

## 介绍

Markdown
Assistant是一款用JavaFX写的Markdown编辑器，基于[Markdown Writer FX](https://www.github.com/JFormDesigner/markdown-writer-fx "Markdown Writer FX")
做了一些定制化修改，添加了一些功能，如果仅需要导出功能可直接使用命令行工具

![Markdown Assistant Screenshot](images/screenshot.png)

## 功能简介

原有功能：

- 语法高亮
- 快捷插入
- 自动缩进
- 查找和替换
- 语法拼写检查
- 工程管理
- HTML源码和HTML预览
- AST视图
- 多平台支持

新增功能：

- 表格编辑器
- 多主题支持（自定义）
- 导出HTML
- 导出PDF（带目录，支持合并，合并后目录功能不受影响）
- 导出Word

## 核心依赖

| 依赖                   | 版本      |
|:---------------------|:--------|
| Markdown Writer FX   | 1.0     |
| RichTextFX           | 0.9.3   |
| ControlsFX           | 8.40.18 |
| ReactFX              | 2.0-M5  |
| WellBehavedFX        | 0.3.3   |
| Flowless             | 0.6     |
| UndoFX               | 2.1.1   |
| MigLayout            | 5.3     |
| flexmark-java        | 0.62.2  |
| commonmark-java      | 0.21.0  |
| CSSFX                | 1.1.1   |
| PrismJS              | 1.29.0  |
| Apache PDFBox        | 3.0.1   |
| picocli-shell-jline3 | 4.7.5   |

## 命令行使用说明

命令行只包含导出功能，导出命令为mdExport，目前支持导出html、pdf及docx

### 交互模式

```
1. 执行markdown-assistant-cmd进入命令行程序
2. 执行导出命令：
   导出单个文件：mdExport -mode=pdf -f=path_to_file
   批量导出：mdExport -mode=pdf -d=path_to_directory
```

### 非交互模式

```
执行导出命令：
导出单个文件：markdown-assistant-cmd mdExport -mode=pdf -f=path_to_file
批量导出：markdown-assistant-cmd mdExport -mode=pdf -d=path_to_directory
```

## 打包编译

### Java版本

8

### 打包命令

```bash
mvn clean package
```