Jasmine.MarkdownToPdf 6.0.2

Jasmine.MarkdownToPdf

HTML 转 PDF 转换库核心模块，提供两种主要使用方式。

两种使用方式

方式一：JasmineConverter（推荐）

适用场景：快速将 HTML 字符串转换为 PDF，无需手动构建文档结构。

特点：

• 简单易用，一行代码完成转换
• 自动解析 HTML 并构建文档模型
• 适合大多数日常场景

基本用法：

using Jasmine.MarkdownToPdf;

// 创建转换器（默认宋体，11pt）
var converter = new JasmineConverter();

// HTML 内容
string html = @"
<p style='text-align: center;'><strong>标题</strong></p>
<p style='text-indent: 2em; line-height: 1.5;'>正文内容</p>
<table>
    <tr><td>单元格 1</td><td>单元格 2</td></tr>
</table>
";

// 同步转换
byte[] pdfBytes = converter.ConvertHtmlToPdf(html);
System.IO.File.WriteAllBytes("output.pdf", pdfBytes);

// 异步转换
byte[] pdfBytes = await converter.ConvertHtmlToPdfAsync(html);

自定义字体：

// 使用微软雅黑，12号字
var converter = new JasmineConverter("Microsoft YaHei", 12f);

// 使用黑体
var converter = new JasmineConverter("SimHei");

直接保存到文件：

// 同步保存
converter.ConvertHtmlToPdfToFile(html, "output.pdf");

// 异步保存
await converter.ConvertHtmlToPdfToFileAsync(html, "output.pdf");

方式二：PdfConverter（进阶）

适用场景：需要精细控制文档结构，手动构建文档内容。

特点：

• 完全控制文档结构
• 支持复杂表格（colspan/rowspan）
• 适合生成结构化报告

基本用法：

using Jasmine.MarkdownToPdf.Converters;
using Jasmine.MarkdownToPdf.Models;

// 创建 PDF 转换器
var pdfConverter = new PdfConverter("Microsoft YaHei", 12f);

// 手动构建文档
var document = new JasmineDocument();

// 添加段落
var paragraph = new JasmineParagraph
{
    Alignment = TextAlignment.Center,
    FirstLineIndent = 0,
    LineSpacing = 1.5,
    TextRuns = new List<JasmineTextRun>
    {
        new JasmineTextRun { Text = "文档标题", IsBold = true, FontSize = 16f }
    }
};
document.Paragraphs.Add(paragraph);

// 添加正文
var body = new JasmineParagraph
{
    Alignment = TextAlignment.Justify,
    FirstLineIndent = 22,
    LineSpacing = 1.5,
    TextRuns = new List<JasmineTextRun>
    {
        new JasmineTextRun { Text = "正文内容..." }
    }
};
document.Paragraphs.Add(body);

// 添加表格
var table = new JasmineTable();
// ... 添加表格行和单元格
document.Tables.Add(table);

// 转换并保存
pdfConverter.Convert(document, "output.pdf");

复杂表格示例（支持 colspan 和 rowspan）：

var table = new JasmineTable();

// 合并单元格示例
var row1 = new JasmineRow();
row1.Cells.Add(new JasmineCell 
{ 
    ColSpan = 3,
    Paragraphs = new List<JasmineParagraph> 
    { 
        new JasmineParagraph { TextRuns = new List<JasmineTextRun> { new JasmineTextRun { Text = "跨3列表头", IsBold = true } } } 
    } 
});
table.Rows.Add(row1);

var row2 = new JasmineRow();
row2.Cells.Add(new JasmineCell { RowSpan = 2, Paragraphs = ... });
row2.Cells.Add(new JasmineCell { Paragraphs = ... });
row2.Cells.Add(new JasmineCell { Paragraphs = ... });
table.Rows.Add(row2);

document.Tables.Add(table);

项目结构

Jasmine.MarkdownToPdf/
├── Converters/        # PDF 转换模块
│   ├── PdfConverter.cs        # PDF 转换核心
│   ├── PdfBuilderHelper.cs    # 构建辅助工具
│   └── FontManager.cs         # 字体管理
├── Models/            # 数据模型
│   ├── JasmineDocument.cs     # 文档模型
│   ├── JasmineParagraph.cs    # 段落模型
│   ├── JasmineTable.cs        # 表格模型
│   ├── JasmineRow.cs          # 表格行模型
│   ├── JasmineCell.cs         # 单元格模型
│   └── JasmineTextRun.cs      # 文本片段模型
├── Parsers/           # HTML 解析模块
│   └── HtmlParser.cs          # HTML 解析器
├── Fonts/             # 字体资源
│   ├── SimSun.ttf             # 宋体
│   ├── MicrosoftYaHei.ttf     # 微软雅黑
│   └── SimHei.ttf             # 黑体
├── IJasmineConverter.cs       # 转换器接口
└── JasmineConverter.cs        # 转换服务入口

核心接口

IJasmineConverter

public interface IJasmineConverter
{
    // 同步转换 HTML 到 PDF
    byte[] ConvertHtmlToPdf(string htmlContent);
    
    // 异步转换 HTML 到 PDF
    Task<byte[]> ConvertHtmlToPdfAsync(string htmlContent, CancellationToken cancellationToken = default);
    
    // 同步转换并保存到文件
    void ConvertHtmlToPdfToFile(string htmlContent, string outputPath);
    
    // 异步转换并保存到文件
    Task ConvertHtmlToPdfToFileAsync(string htmlContent, string outputPath, CancellationToken cancellationToken = default);
}

PdfConverter

public class PdfConverter
{
    // 构造函数
    public PdfConverter(string customFontFamily = null, float defaultFontSize = 11f);
    
    // 转换并保存到文件
    void Convert(JasmineDocument document, string outputPath);
    
    // 异步转换并保存
    Task ConvertAsync(JasmineDocument document, string outputPath, CancellationToken cancellationToken = default);
    
    // 转换为字节数组
    byte[] ConvertToBytes(JasmineDocument document);
    
    // 异步转换为字节数组
    Task<byte[]> ConvertToBytesAsync(JasmineDocument document, CancellationToken cancellationToken = default);
}

支持的字体

输出格式

• 页面大小：A4
• 页边距：2 厘米（上下左右）
• 默认字体：宋体，11pt
• 页面方向：纵向

选择哪种方式？

许可证

本项目采用 MIT 许可证。详情请查看项目根目录的 LICENSE 文件。

贡献指南

欢迎贡献代码！请遵循以下流程：

1. Fork 仓库
2. 创建功能分支
3. 实现功能或修复问题
4. 编写测试
5. 提交代码（遵循约定式提交规范）
6. 创建 Pull Request

问题反馈

如有问题或建议，请在仓库的 Issue 页面提交。提交时请包含：

• 问题描述
• 复现步骤
• 环境信息
• 相关代码示例