使用Java实现将Markdown转换为PDF并自定义PDF页面设置_Java

markdown 广泛应用于技术文档、项目说明、readme 文件以及在线内容创作中。由于语法简单、易于维护，开发者可以使用 markdown 快速编写和管理结构化内容。

不过，markdown 并不总是适合作为最终交付格式。当文档需要打印、归档或分享给不熟悉 markdown 工具的用户时，pdf 通常是更合适的选择，因为它可以保持固定布局，并确保在不同平台上的显示效果一致。

在 java 应用中，将 markdown 自动转换为 pdf 可以应用于文档管理系统、报告生成平台以及内容发布流程中。

本文将介绍如何使用 java 将 markdown 文件转换为 pdf，并进一步自定义生成 pdf 文档的页面设置。

为什么需要将 markdown 转换为 pdf？

markdown 和 pdf 适用于不同的场景。

markdown 在内容创建阶段更加方便：

语法简单，易于阅读；
适合使用版本控制管理；
内容和格式相对分离；
后期修改和维护成本较低。

而 pdf 更适合作为最终发布格式：

在不同设备上保持一致的布局；
可以直接打印；
方便归档和共享；
用户无需安装 markdown 编辑工具即可查看。

常见应用场景包括：

将技术文档转换为 pdf 手册；
根据 markdown 模板生成报告；
自动创建可下载的文档；
发布博客文章或企业知识库内容。

准备工作

在开始转换 markdown 文件之前，需要准备：

java development kit (jdk)；
支持 markdown 加载和 pdf 导出的 java 文档处理库。

本文示例使用 spire.doc for java 完成 markdown 文档加载和 pdf 转换。

添加依赖

如果使用 maven 管理 java 项目，可以在 pom.xml 文件中添加以下依赖：

<repositories>
    <repository>
        <id>com.e-iceblue</id>
        <name>e-iceblue</name>
        <url>https://repo.e-iceblue.cn/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupid>e-iceblue</groupid>
        <artifactid>spire.doc</artifactid>
        <version>14.7.4</version>
    </dependency>
</dependencies>

使用 java 将 markdown 转换为 pdf

添加依赖后，可以加载 markdown 文件，并将其保存为 pdf 格式。

整个转换过程只需要几个步骤：

创建 document 对象；
加载 markdown 文件；
使用 pdf 格式保存文档。

示例代码如下：

import com.spire.doc.document;
import com.spire.doc.fileformat;

public class markdowntopdf {

    public static void main(string[] args) {

        document doc = new document();

        // 加载 markdown 文件
        doc.loadfromfile("sample.md");

        // 保存为 pdf
        doc.savetofile(
                "output/markdowntopdf.pdf",
                fileformat.pdf
        );

        doc.dispose();
    }
}

运行代码后，markdown 文件中的内容会被转换为 pdf 文档。

自定义生成 pdf 的页面设置

对于很多实际应用场景，默认页面布局可能无法满足需求。例如，报告、技术手册或打印文档通常需要指定：

页面大小；
页面方向；
页边距。

在导出 pdf 之前，可以通过文档的 pagesetup 对象调整这些页面属性。

下面的示例将页面设置为 a4 纸张、纵向布局，并调整页面边距：

import com.spire.doc.document;
import com.spire.doc.fileformat;
import com.spire.doc.pagesetup;
import com.spire.doc.section;
import com.spire.doc.documents.marginsf;
import com.spire.doc.documents.pageorientation;
import com.spire.doc.documents.pagesize;

public class markdownpagesettings {

    public static void main(string[] args) {

        document doc = new document();

        // 加载 markdown 文件
        doc.loadfromfile("sample.md");

        // 获取文档中的第一个 section
        section section = doc.getsections().get(0);

        // 配置页面设置
        pagesetup pagesetup = section.getpagesetup();

        pagesetup.setpagesize(pagesize.a4);

        pagesetup.setorientation(
                pageorientation.portrait
        );

        pagesetup.setmargins(
                new marginsf(72, 72, 72, 72)
        );

        // 保存为 pdf
        doc.savetofile(
                "output/markdowntopdf_custom.pdf",
                fileformat.pdf
        );

        doc.dispose();
    }
}

通过这些设置，生成的 pdf 将按照指定的页面布局输出，而不是使用默认配置。