Преобразовать документ в Markdown

Markdown - популярный формат, используемый для разметки текста, который в дальнейшем преобразуется в HTML, PDF, DOCX, или другие форматы. Многие разработчики выбирают этот формат для написания документации, подготовки статей для публикации в блогах, описания проектов и так далее.

Markdown настолько популярен, потому что с этим форматом легко работать, а также его можно довольно просто преобразовать в другие форматы. По этой причине Aspose.Words предоставляет возможность конвертировать документ из любой поддерживаемый формат загрузки в Markdown и наоборот – Aspose.Words также поддерживает наиболее популярный сохранение форматов.

Сейчас активно развивается функционал для работы с форматом Markdown, чтобы предоставить вам больше возможностей для удобной и комфортной работы с документами.

Преобразовать документ в Markdown

Чтобы преобразовать документ в формат Markdown, вам просто нужно загрузить документ в любом поддерживаемом формате или создать новый программно. Затем вам нужно сохранить документ в формате Markdown.

В следующем примере кода показано, как преобразовать DOCX в Markdown:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Load the document from disk.
Document doc = new Document(dataDir + "Test.docx");

// Save the document to Markdown format.
doc.save(dataDir + "SaveDocx2Markdown.md");

Укажите параметры сохранения при преобразовании в Markdown

Aspose.Words предоставляет возможность использовать класс MarkdownSaveOptions для работы с расширенными параметрами при сохранении документа в формате Markdown. В дополнение к другим наследуемым или перегружаемым свойствам, также был добавлен ряд свойств, специфичных для формата Markdown. Например, свойство TableContentAlignment для управления выравниванием содержимого в таблицах или ImageSavingCallback и ImagesFolder для управления сохранением изображений при преобразовании документа в формат Markdown.

Поддерживаемые функции Markdown

Aspose.Words в настоящее время поддерживает следующие Markdown функции, которые в основном соответствуют спецификации CommonMark в Aspose.Words API и представлены в виде соответствующих стилей или прямого форматирования:

• Заголовки – это абзацы со стилями Heading 1 - Heading 6
• Блок-кавычки - это абзацы с надписью “Quote” в названии стиля
• IndentedCode - это абзацы с “IndentedCode” в названии стиля
• FencedCode - это абзацы с “FencedCode” в названии стиля
• InlineCode - это запуски с “InlineCode” в названии стиля Font
• Горизонтальные правила - это абзацы с формой HorizontalRule
• Жирный акцент
• Выделено курсивом
• StrikeThrough форматирование
• Списки представляют собой пронумерованные или маркированные абзацы
• Таблицы представлены с помощью класса Table
• Ссылки представлены в виде класса FieldHyperlink

В следующем примере показано, как создать документ с некоторыми стилями и сохранить его в Markdown:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Specify the "Heading 1" style for the paragraph.
builder.insertParagraph();
builder.getParagraphFormat().setStyleName("Heading 1");
builder.write("Heading 1");

// Specify the Italic emphasis for the paragraph.
builder.insertParagraph();
// Reset styles from the previous paragraph to not combine styles between paragraphs.
builder.getParagraphFormat().setStyleName("Normal");
builder.getFont().setItalic(true);
builder.write("Italic Text");
// Reset styles from the previous paragraph to not combine styles between paragraphs.
builder.setItalic(false);

// Specify a Hyperlink for the desired text.
builder.insertParagraph();
builder.insertHyperlink("Aspose","https://www.aspose.com", false);
builder.write("Aspose");

// Save your document as a Markdown file.
doc.save(dataDir + "example.md");

Результат выполнения этого примера кода показан ниже.

Полезные советы

Есть несколько нюансов и интересных кейсов, узнав которые, вы сможете работать с файлами Markdown более гибко и удобно. Например, есть возможность использовать:

• SetextHeading это позволяет создавать многострочные заголовки в Markdown, в то время как обычные заголовки в Markdown могут быть только однострочными. SetextHeading основан на стиле “Заголовок N”, и его уровень может быть только 1 или 2. Если N в “товарной позиции N” больше или равно 2, то соответствующий SetextHeading основан на “Heading 2”, в противном случае - на “Heading 1”.
• Различные маркеры для первого уровня маркированных списков ("-", “+” или “*”, маркер по умолчанию равен “-”.) и различные типы нумерации для упорядоченных списков ("." или “)”, маркер по умолчанию равен “.").