Saltar al contenido principal

Convertir Markdown a PDF en Make

Convertir Markdown a PDF es un Make módulo por PDF4me que transforma un archivo .md o un ZIP archivo de Markdown en un acabado pulido PDF documento dentro de su escenario de automatización. Úselo para publicar archivos README, documentos técnicos o exportaciones de wiki como PDFs. El módulo conserva los encabezados, los bloques de código, las tablas y el énfasis en la salida.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog

Autenticando su API Pedido

Para acceder al PDF4me Web API a través de MakeCada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado, lo que permite una integración perfecta entre su Make escenarios y PDF4me's Markdown servicios de conversión.

Datos importantes que no debes perderte

ZIP La entrada requiere el campo Ruta de archivo Markdown.
Cuando el documento sea un archivo .zip, rellene la ruta del archivo Markdown con la ruta relativa al archivo .md que contiene, por ejemplo docs/README.mdDéjelo vacío para un archivo .md directo; omitirlo en un ZIP La entrada provoca que el módulo falle.
Se conserva el formato con estilo de GitHub.
Los encabezados, las listas, el texto en negrita y cursiva, el código en línea, los bloques de código delimitados, las tablas y las citas en bloque se muestran correctamente. Es posible que las imágenes a las que se hace referencia mediante una ruta relativa no se carguen, por lo que se recomienda usar rutas absolutas. URLs para imágenes incrustadas.
Utilice un iterador para convertir un conjunto completo de documentación.
El módulo convierte uno Markdown archivo por ejecución. Para procesar una carpeta de archivos .md, coloque un Repeater o Iterator antes de este módulo para que cada iteración procese un archivo.
Módulo PDF4me Convertir Markdown a PDF en Make que muestra los campos Conexión, Nombre de archivo, Documento y Ruta de archivo Markdown.

Seleccione su PDF4me conexión, mapee el nombre del archivo y el documento del paso de descarga anterior, luego establezca la ruta del archivo Markdown solo cuando el documento sea un ZIP archivo.

¿Qué es convertir? Markdown a PDF en Make¿

Convertir Markdown a PDF es Make's PDF4me módulo para renderizado Markdown fuente en un PDF documento programáticamente. Acepta un archivo .md o un ZIP archivar como un búfer binario y devolver un formato PDFA diferencia de un convertidor en línea de un solo uso, este módulo se ejecuta dentro de un escenario automatizado, por lo que cada nuevo README, actualización de documentación o exportación de wiki recibe un PDF versión sin pasos manuales.

Parámetros

ParámetroRequeridoLo que haceEjemplo
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

Producción

CampoTipoLo que contiene
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.

¿Cómo se convierte? Markdown a PDF trabajar en Make¿

El módulo lee el Markdown El búfer que se asigna a él renderiza encabezados, listas, tablas, bloques de código y énfasis en un diseño fijo, y transmite el resultado de vuelta como un PDF en el campo Datos del documento. Para un ZIP Primero extrae el archivo especificado en la ruta de archivo Markdown y luego renderiza solo ese archivo. Markdown sí sigue el Especificación CommonMarky la versión de GitHub lo amplía con tablas y listas de tareas como se documenta en Guía de Markdown de GitHubPara patrones de creación de escenarios, consulte el Centro de ayuda.

Configuraciones típicas

README PDF en la versión de GitHub
  1. Se activa al crearse una nueva versión en un repositorio de GitHub.
  2. Descarga el archivo README.md del repositorio.
  3. Pasar el nombre del archivo y el documento a Convert Markdown a PDF.
  4. Adjunte el devuelto PDF a los recursos de lanzamiento de GitHub.
Convertir por lotes una carpeta de documentación
  1. Permite listar todos los archivos .md de una carpeta de documentos con un módulo de lista de GitLab o Dropbox.
  2. Recorre la lista y descarga cada archivo.
  3. Ejecutar Convertir Markdown a PDF en cada iteración.
  4. Subir cada uno PDF a un portal de documentación o a una unidad compartida.
Archivar una exportación de wiki como PDF
  1. Exportar páginas wiki como un ZIP de Markdown archivos de Confluence o wiki de GitLab.
  2. Mapa del ZIP Agregue un búfer al documento y establezca la ruta del archivo Markdown a la página que desee.
  3. Ejecutar Convertir Markdown a PDF para cada ruta de página.
  4. Almacene el resultado PDFs en una carpeta de archivo de Google Drive.

Consejos prácticos

Establecer ruta de archivo Markdown solo para ZIP aporte
Déjelo vacío cuando el documento sea un archivo .md directo. Omitirlo en un ZIP La entrada provoca que el módulo falle porque no puede encontrar un archivo para renderizar.
Utilice una imagen absoluta. URLs
Rutas de imagen relativas en el Markdown Es posible que la fuente no se resuelva en el momento de la renderización. Apunte las referencias de imagen a un https:// completo URL así aparecen en el PDF.
Mantenga la extensión del archivo en el nombre del archivo.
Incluya .md o .zip en el nombre del archivo para que el módulo y los módulos posteriores reconozcan correctamente el formato de origen.
Iterar para varios archivos
El módulo renderiza uno Markdown fuente por ejecución. Coloque un Repetidor o Iterador delante para procesar una carpeta completa de archivos .md.
Los créditos se consumen por conversión.
Cada carrera consume PDF4me créditos de tu plan. Revisa el uso de tu panel de control antes de dimensionar una conversión de lote grande.

Hoja de trucos

CampoValor
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)

Preguntas frecuentes

¿Cómo convierto? Markdown a PDF en Make¿+
Añade el PDF4me Convertir Markdown a PDF módulo a un Make escenario, conéctelo, asigne el nombre del archivo y el documento de un paso de descarga anterior y ejecute el escenario. El módulo devuelve un renderizado PDF en el campo Datos del documento sin ningún paso de conversión manual.
¿Puedo convertir un? ZIP archivo de Markdown ¿Documentos a la vez?+
El módulo convierte uno Markdown archivo por ejecución, pero ese archivo puede provenir de dentro de un ZIP archivo cuando establece Markdown File Path a la ruta relativa del archivo .md en el ZIPPara convertir una carpeta de archivos .md separados, ejecute el módulo una vez por archivo dentro de una carpeta. Make Iterador.
¿Por qué no aparecen mis imágenes en la conversión? PDF¿+
Imágenes referenciadas por una ruta relativa en el Markdown La fuente puede no resolverse cuando el PDF se renderiza. Usar absoluto URLs para imágenes incrustadas para que se carguen correctamente en la salida PDF. El Guía de Markdown para GitHub Cubre la sintaxis de las imágenes en detalle.
¿Qué formatos Markdown admite el módulo?+
El módulo conserva el estilo de GitHub. Markdown elementos que incluyen encabezados, listas ordenadas y no ordenadas, énfasis en negrita y cursiva, código en línea, bloques de código delimitados, tablas y citas en bloque, después de la Especificación CommonMark que amplía GitHub Flavored Markdown.

Casos de uso y aplicaciones en la industria

  • Documentación README: Convertir archivos README a PDF para las versiones
  • Documentación de la APIGenerar documentos PDF a partir de Markdown
  • Registros de cambiosConvertir CHANGELOG.md a formato PDF
  • Guías para colaboradores: Crear guías en PDF a partir de Markdown

Acciones relacionadas

La misma tarea en otras plataformas

Obtén ayuda