Export documents to Markdown using Java

Product Page | Docs | Release Notes | Examples | Blog | Free Support | Temporary License | Pricing

GroupDocs.Markdown for Java is a native, on-premise Java API to export PDF, Word, Excel, and other formats to clean Markdown. You control your data - no cloud or internet connection required.

Version 26.5 is a major release. It introduces a redesigned public API, a custom DOM-based Markdown renderer, Markdown flavor control, document inspection, and URI resource support. See the 26.5 release notes for the full list of changes and breaking changes.

Key features

• Export multiple document formats to Markdown (PDF, DOCX, XLSX, EPUB, and more).
• Custom DOM-based renderer with support for headings, paragraphs, lists, tables, links, images, blockquotes, and code blocks.
• Markdown flavor control - target GitHub Flavored Markdown or CommonMark.
• Document inspection without conversion, and format discovery through static helpers.
• Load documents straight from a URI, without downloading them first.
• Spreadsheet rendering options - row and column limits, sheet separators, and hidden sheet filtering.
• Full control over images: embed images into Markdown or export them separately with relative paths.

Supported Document File

The supported load file formats of GroupDocs.Markdown for Java are as follows:

PDF: PDF
Microsoft Word®: DOC/DOCX/DOT/DOTM/DOTX/DOCM/RTF
OpenOffice Writer®: ODT/OTT
Microsoft Excel®: XLS/XLSX/XLSB/XLSM/XLT/XLTX/XLTM/XLAM
OpenOffice Calc®: ODS/OTS/FODS
Apple®: NUMBERS
Other Spreadsheet: CSV/TSV/SXC
eBook: AZW3/MOBI/EPUB
Text / Markup / Help: CHM/XML/TXT

For details and limitations please visit, Supported Document Formats.

System Requirements

• Windows, Linux, or macOS
• Java 8 (JRE/JDK 1.8) or later

GroupDocs.Markdown for Java does not require any external software or third-party tools. Just follow the steps in the Installation and Configuration guide.

Get Started

GroupDocs hosts all Java APIs at the GroupDocs Repository. You can easily use GroupDocs.Markdown for Java API directly in your Maven projects with simple configurations. For detailed instructions, see Installation.

Sample Java code to Convert DOCX into Markdown

import com.groupdocs.markdown.*;

public class Main {
    public static void main(String[] args) {
        // Set the license (optional)
        License.setLicense("GroupDocs.Markdown.lic");

        // Convert a document to a Markdown string
        String markdown = MarkdownConverter.toMarkdown("sample.docx");

        // Or convert straight to a file
        MarkdownConverter.toFile("sample.docx", "result.md");
    }
}

Sample Java code to control the Markdown flavor and image export

import com.groupdocs.markdown.*;

public class Main {
    public static void main(String[] args) {
        // Instantiate the converter
        MarkdownConverter converter = new MarkdownConverter("sample.docx");

        // Target GitHub Flavored Markdown and export images to a folder
        DocumentConvertOptions options = new DocumentConvertOptions();
        options.setFlavor(MarkdownFlavor.GITHUB);
        options.setImageExportStrategy(new ExportImagesToFileSystemStrategy("images"));

        // Convert and inspect any non-fatal warnings
        DocumentConvertResult result = converter.convert(options);

        for (String warning : result.getWarnings()) {
            System.out.println(warning);
        }
    }
}

Product Page | Docs | Examples | Blog | Free Support | Temporary License