一览 GroupDocs.Markdown

用于在 .NET 应用程序中解析并导出文档为 Markdown 的 API。

Illustration markdown

精准可靠的转换

高效将受支持的格式转换为 Markdown,同时保持结构完整性。支持 Windows 和 Linux 上的 .NET Framework 4.6.2+ 与 .NET 6.0。

支持常见格式

将 PDF、Word、Excel、电子书、Web 和纯文本文件导出为 Markdown,包括受密码保护的文档。

在本地机器上运行

您掌控自己的数据——我们提供无需任何云或互联网连接的本地 API。

平台支持

支持以下操作系统、框架和包管理器。

Amazon
Docker
Azure
VS Code
ReSharper
macOS
Linux
NuGet

支持的文件格式

支持以下文件格式导出为 Markdown。

PDF

  • Digital PDFs, PDF/A, PDF/E, PDF/X and PDF/UA
  • Encrypted and Signed PDFs

Word 与 Excel

  • Word: DOCX, DOC, RTF, DOCM, DOTX, DOTM, DOT, ODT, OTT
  • Excel: XLSX, XLS, CSV, XLSM, XLSB, ODS, TSV, NUMBERS, XLTX, XLTM, XLAM, FODS, SXC, OTS, XLT

其他

  • e-Books: EPUB, MOBI, AZW3
  • Text: TXT, XML
  • Web: CHM

GroupDocs.Markdown 功能

以下是使我们的产品脱颖而出的功能。

Feature icon

导出多种文档格式

将最流行的文档格式(PDF、DOCX、XLSX、EPUB 等)转换为 Markdown。

Feature icon

高级 Markdown 格式化

标题、段落、列表、表格、链接、图像、块引用和代码块均导出为相应的 Markdown 语法。

Feature icon

对图像的完全控制

通过导出图像或将其嵌入输出的 Markdown 文件来控制图像。

Feature icon

在本地机器上运行

无需云服务或互联网连接。所有处理均在本地机器上完成。

Feature icon

直观的公共 API

由开发者为开发者精心设计的简洁直观的公共 API。

Feature icon

支持 Windows 和 Linux

.NET 和 .NET Framework 程序集已包含在 NuGet 包中。

代码示例

.NET 应用程序中导出文档为 Markdown 的最常见使用场景。

导出 DOCX 为 Markdown

此代码示例展示了如何将 DOCX 文件转换为 Markdown 并将输出保存到文件。图像嵌入到输出文件中。
// 导入命名空间
using GroupDocs.Markdown;

// 设置许可证
License.Set("GroupDocs.Markdown.lic");

// 实例化转换器
var converter = new MarkdownConverter("annual-review.docx");

// 转换并将输出保存到文件
converter.Convert("annual-review.md");
// 导入命名空间  
open GroupDocs.Markdown

// 设置许可证
License.Set("GroupDocs.Markdown.lic")

// 实例化转换器
let converter = new MarkdownConverter("annual-review.docx")

// 转换并将输出保存到文件
converter.Convert("annual-review.md")
' 导入命名空间  
Imports GroupDocs.Markdown

Module Program
    Sub Main()
        ' 设置许可证
        License.Set("GroupDocs.Markdown.lic")

        ' 实例化转换器
        Dim converter As New MarkdownConverter("annual-review.docx")

        ' 转换并将输出保存到文件
        converter.Convert("annual-review.md")
    End Sub
End Module

将图像保存到文件夹

此代码示例展示了如何将 DOCX 文件转换为 Markdown 并将图像保存到单独的文件夹。
// 导入命名空间
using GroupDocs.Markdown;

// 实例化转换器
using var converter = new MarkdownConverter("annual-report.docx");

// 设置图像导出策略和输出文件夹
var options = new ConvertOptions
{
    ImageExportStrategy = new ExportImagesToFileSystemStrategy("./images")
    {
        ImagesRelativePath = "images"
    }
};

// 转换并将输出保存到文件
converter.Convert("annual-report.md", options);
// 导入命名空间
open GroupDocs.Markdown

// 实例化转换器
use converter = new MarkdownConverter("annual-report.docx")

// 设置图像导出策略和输出文件夹
let options = ConvertOptions()
let strategy = ExportImagesToFileSystemStrategy("./images")
strategy.ImagesRelativePath <- "images"
options.ImageExportStrategy <- strategy

// 转换并将输出保存到文件
converter.Convert("annual-report.md", options)
' 导入命名空间  
Imports GroupDocs.Markdown

' 实例化转换器
Using converter As New MarkdownConverter("annual-report.docx")

    ' 设置图像导出策略和输出文件夹
    Dim strategy As New ExportImagesToFileSystemStrategy("./images")
    strategy.ImagesRelativePath = "images"
    Dim options As New ConvertOptions()
    options.ImageExportStrategy = strategy

    ' 转换并将输出保存到文件
    converter.Convert("annual-report.md", options)
End Using

检查文档并转换特定页面

在转换之前获取文档元数据,然后仅导出所需页面——适用于大型文档和 AI/RAG 流程。
// 导入命名空间
using GroupDocs.Markdown;

// 在不转换的情况下检查文档
DocumentInfo info = MarkdownConverter.GetInfo("report.pdf");
Console.WriteLine($"{info.PageCount} pages, by {info.Author}");

// 仅将前 3 页转换为带有 front matter 的内容
var options = new ConvertOptions
{
    PageNumbers = new[] { 1, 2, 3 },
    IncludeFrontMatter = true
};

// 使用单行静态方法
string md = MarkdownConverter.ToMarkdown("report.pdf", options);
// 导入命名空间
open GroupDocs.Markdown

// 在不转换的情况下检查文档
let info = MarkdownConverter.GetInfo("report.pdf")
printfn "%d pages, by %s" info.PageCount info.Author

// 仅将前 3 页转换为带有 front matter 的内容
let options = ConvertOptions()
options.PageNumbers <- [| 1; 2; 3 |]
options.IncludeFrontMatter <- true

// 使用单行静态方法
let md = MarkdownConverter.ToMarkdown("report.pdf", options)
' 导入命名空间
Imports GroupDocs.Markdown

' 在不转换的情况下检查文档
Dim info As DocumentInfo = MarkdownConverter.GetInfo("report.pdf")
Console.WriteLine($"{info.PageCount} pages, by {info.Author}")

' 仅将前 3 页转换为带有 front matter 的内容
Dim options As New ConvertOptions()
options.PageNumbers = {1, 2, 3}
options.IncludeFrontMatter = True

' 使用单行静态方法
Dim md As String = MarkdownConverter.ToMarkdown("report.pdf", options)

准备好开始了吗?

免费下载 GroupDocs.Markdown 或获取试用许可证以获得完全访问权限!

有用的资源

探索文档,代码样本和社区支持,以增强您的体验。

临时许可提示

1
使用您的工作电子邮件地址进行注册。不允许使用免费邮件服务。
2
使用第二步中的获取临时许可证按钮。
 中国人