MD2File

Что умеет делать MD2File?

Может экспортировать содержимое документа с разметкой markdown в файлы форматов word, pdf и HTML.

Markdown используется потому, что он хорошо анализируется, а текст в формате md обычно имеет более структурированное содержание. Кроме того, преобразование html в md также относительно просто.

В настоящее время MD2File поддерживает большую часть базовой грамматики markdown (включая синтаксис таблиц). Неупорядоченные и упорядоченные списки пока не поддерживают многоуровневые списки.

Экспортированный документ word имеет наилучшее форматирование в Microsoft Office Word, поскольку при разработке poi основной упор делался на поддержку ms word. В wps результат тоже неплох. В pages основная вёрстка содержимого нормальная, но некоторые стили не поддерживаются. Экспортированный PDF-документ по сравнению с документом word выглядит намного лучше.

Дополнительная функция разработки: поддержка преобразования markdown в HTML-текст

Поскольку MD2File уже может экспортировать HTML-файлы, поддержка преобразования markdown в HTML — это вопрос нескольких секунд.

Был добавлен класс MDUtil для поддержки этой функции. На данный момент нет хорошего jar-файла для преобразования markdown в html на java, у всех есть свои недостатки. Конечно, в настоящее время у MD2File тоже есть некоторые проблемы, но они будут постепенно улучшаться, и это обещание автора.

Функция преобразования markdown в HTML была выделена отдельно и помещена в другой проект: MDTool, который является более чистым. Если вам нужна только эта функция, вы можете посмотреть её там.

Простой пример

@Test
public void test(){
	try {
		// Экспорт текста
		FileFactory.produce(new File("test_file/md_for_test.md"), "test_file/test.docx");
		FileFactory.produce(new File("test_file/md_for_test.md"), "test_file/test.pdf");
		FileFactory.produce(new File("test_file/md_for_test.md"), "test_file/test.html");
	} catch (FileNotFoundException e) {
		e.printStackTrace();
	}
	// Преобразование markdown в html
	System.out.println(MDUtil.markdown2Html("[**开源中国**](http://www.oschina.net)社区，是一个很不错的网站。欢迎上去查找开源软件，吐吐槽！"));
}

Как получить доступ к MD2File, этому открытому инструменту?

// Поддержка maven
<dependency>
    <groupId>com.youbenzi</groupId>
    <artifactId>MD2File</artifactId>
    <version>1.0.2</version>
</dependency>

или

// Поддержка gradle
compile 'com.youbenzi:MD2File:1.0.1'

Код уже размещён по адресу: https://git.oschina.net/cevin15/MD2File.

Если вам интересно, можете поставить звёздочку.

Некоторые пояснения о MD2File

Использование очень простое, можно использовать методы, предоставляемые FileFactory. Экспорт word зависит от poi, pdf зависит от itext, html не имеет других зависимостей, которые можно ясно увидеть через файл pom.xml.

Если вы считаете, что стиль по умолчанию не соответствует вашим требованиям, вы можете разветвить проект и реализовать его, изменив класс *Decorator.

PS. Если вам нужен только функционал преобразования markdown в HTML, вы можете обратиться к этому месту.

Благодарности

Сяо Шэнь