跳到主要内容

转变 MarkdownPDFMake

转变 MarkdownPDF 是一个 Make 模块 PDF4me 它可以转换 .md 文件或 ZIP 档案 Markdown 打磨成光滑的 PDF 在自动化场景中创建文档。可用于发布 README 文件、技术文档或 wiki 导出内容。 PDF该模块在输出中保留标题、代码块、表格和强调部分。

相关博客文章
目前尚无关于此功能的博客文章——敬请期待。
在此期间,您可以浏览 PDF4me 博客,查看适用于各平台的教程和工作流程。
访问博客

验证您的身份 API 要求

要访问 PDF4me 网站 API 通过 Make每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全,并验证您作为授权用户的身份,从而实现与您的系统之间的无缝集成。 Make 场景和 PDF4meMarkdown 转换服务。

您不容错过的重要事实

ZIP 输入内容需要 Markdown 文件路径字段
如果文档是 .zip 压缩包,请在 Markdown 文件路径中填写指向其中 .md 文件的相对路径,例如: 文档/README.md留空则直接使用 .md 文件;省略则用于 ZIP 输入错误导致模块运行失败。
GitHub风格的格式得以保留
标题、列表、粗体和斜体强调、行内代码、代码块、表格和引用块都能正确显示。使用相对路径引用的图片可能无法加载,因此请使用绝对路径。 URL用于嵌入图像。
使用迭代器转换整个文档集
该模块转换一个 Markdown 每次运行处理一个文件。要处理一个包含 .md 文件的文件夹,请在此模块前放置一个 Repeater 或 Iterator,以便每次迭代处理一个文件。
PDF4me Markdown 转 PDF 模块在 Make 中显示连接、文件名、文档和 Markdown 文件路径字段

选择您的 PDF4me 连接后,映射上一步下载步骤中的文件名和文档,然后仅当文档为 Markdown 文件时才设置 Markdown 文件路径。 ZIP 档案。

什么是转换 MarkdownPDFMake

转变 MarkdownPDFMakePDF4me 用于渲染的模块 Markdown 源头进入 PDF 以编程方式编写文档。它接受 .md 文件或 ZIP 将归档文件保存为二进制缓冲区,并返回格式化后的文件。 PDF与一次性的在线转换器不同,此模块在自动化流程中运行,因此每次新的 README 文件、文档更新或 wiki 导出都会自动进行转换。 PDF 无需手动步骤的版本。

参数

范围必需的它的作用例子
ConnectionRequiredPDF4me connection holding your API key. Create one from the Make Connections panel using your key from dev.pdf4me.com/dashboard.TestUser01
File NameRequiredMarkdown filename with a .md extension, or .zip for a ZIP archive containing Markdown. Map it from the prior module output. Drives the output PDF name.README.md
DocumentRequiredBinary Markdown or ZIP file content as a Make buffer. Map from the Data field of a GitHub, GitLab, Dropbox, or HTTP download module.1. Data
Markdown File PathConditionalRelative path to the .md file inside a ZIP archive. Required only when Document is a ZIP; leave empty for a direct .md file.docs/README.md

输出

场地类型它包含什么
NameStringOutput PDF filename derived from the Markdown source filename. Use it in the destination upload module File Name field.
Doc DataBufferBinary PDF content rendered from the Markdown source. Map directly into a cloud-storage upload module, an email attachment, or a merge step.

如何转换 MarkdownPDF 在工作 Make

该模块读取 Markdown 缓冲区会将您映射到其中,并将标题、列表、表格、代码块和重点内容渲染到固定布局中,然后将结果作为流式传输返回。 PDF 在“文档数据”字段中。对于 ZIP 输入后,它首先提取 Markdown 文件路径中指定的文件,然后仅渲染该文件。 Markdown 它本身遵循 CommonMark 规范GitHub 版本在此基础上扩展了表格和任务列表,具体文档请参见[此处]。 GitHub 的 Markdown 指南有关场景构建模式,请参阅 创建帮助中心

典型配置

GitHub 版本上的 README PDF 文件
  1. 触发条件是GitHub仓库中创建了新版本。
  2. 从存储库下载 README.md 文件。
  3. 将文件名和文档传递给 Convert MarkdownPDF
  4. 附上退回的 PDF 到 GitHub 发布资源。
批量转换文档文件夹
  1. 使用 GitLab 或 Dropbox List 模块列出 docs 文件夹中的所有 .md 文件。
  2. 遍历列表并下载每个文件。
  3. 运行转换器 MarkdownPDF 在每次迭代中。
  4. 上传每个 PDF 上传到文档门户或共享驱动器。
将维基导出文件归档为 PDF
  1. 将维基页面导出为 ZIPMarkdown 来自 Confluence 或 GitLab wiki 的文件。
  2. 绘制地图 ZIP 将缓冲区保存到文档中,并将 Markdown 文件路径设置为所需的页面。
  3. 运行转换器 MarkdownPDF 对于每个页面路径。
  4. 存储结果 PDF位于 Google 云端硬盘存档文件夹中。

实用技巧

仅为 Markdown 文件路径设置 ZIP 输入
如果文档是直接的 .md 文件,则将其留空。省略此字段 ZIP 输入错误导致模块运行失败,因为它找不到要渲染的文件。
使用绝对图像 URLs
图像中的相对路径 Markdown 源文件可能无法在渲染时解析。请将图像引用指向完整的 https:// URL 所以它们出现在…… PDF
文件名中保留文件扩展名
文件名中包含 .md 或 .zip,以便模块和下游模块能够正确识别源格式。
遍历多个文件
该模块渲染一个 Markdown 每次运行处理一个源文件。在其前面放置一个 Repeater 或 Iterator 来处理整个文件夹中的 .md 文件。
每次转化消耗积分
每次运行消耗 PDF4me 您的套餐额度已用完。在进行大批量转换之前,请先查看您的控制面板使用情况。

速查表

场地价值
ModulePDF4me > Convert Markdown to PDF
ConnectionYour PDF4me connection (key from dev.pdf4me.com/dashboard)
File NameREADME.md
Document1. Data (binary from prior download)
Markdown File Pathdocs/README.md (ZIP input only)
OutputDoc Data (rendered PDF buffer)

常见问题解答

如何转换 MarkdownPDFMake+
添加 PDF4me 转变 MarkdownPDF 模块到 Make 设想一个场景,连接它,映射先前下载步骤中的文件名和文档,然后运行该场景。该模块返回一个渲染后的结果。 PDF 在“文档数据”字段中,无需手动转换步骤。
我可以转换一个 ZIP 文件 Markdown 一次性提交多个文件?+
该模块转换一个 Markdown 每次运行生成一个文件,但该文件可以来自内部 ZIP 当您将 Markdown 文件路径设置为 .md 文件的相对路径时,归档文件将无法正常工作。 ZIP要转换一个包含多个 .md 文件的文件夹,请对每个文件运行一次该模块。 Make 迭代器。
为什么我的图片在转换后的文件里显示不出来? PDF+
通过相对路径引用的图像 Markdown 当源无法解析时 PDF 已渲染。请使用绝对定位。 URLs 用于嵌入图像,以便它们在输出中正确加载 PDF。 这 GitHub Markdown 指南 详细介绍图像语法。
该模块支持哪些 Markdown 格式?+
该模块保留了 GitHub 风格 Markdown 元素包括标题、有序列表和无序列表、粗体和斜体强调、行内代码、代码块、表格和引用块,遵循以下规则: CommonMark 规范 GitHub Flavored Markdown 是其扩展。

行业应用案例及应用

  • 自述文件将 README 文件转换为 PDF 格式,以便发布。
  • API 文档从 Markdown 生成 PDF 文档
  • 变更日志将 CHANGELOG.md 转换为 PDF 格式
  • 贡献指南使用 Markdown 创建 PDF 指南

相关操作

在其他平台上执行相同任务

获取帮助