Pular para o conteúdo principal

Converter Markdown para PDF em Make

Converter Markdown para PDF é um Make módulo por PDF4me que transforma um arquivo .md ou um ZIP arquivo de Markdown em um polido PDF documento dentro do seu cenário de automação. Use-o para publicar arquivos README, documentação técnica ou exportações wiki como PDFO módulo preserva títulos, blocos de código, tabelas e ênfase na saída.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue

Autenticando seu API Solicitar

Para acessar o PDF4me Web API através MakePara que uma solicitação seja válida, é necessário incluir credenciais de autenticação adequadas. A autenticação garante uma comunicação segura e valida sua identidade como usuário autorizado, permitindo uma integração perfeita entre seus sistemas. Make cenários e PDF4me's Markdown serviços de conversão.

Fatos importantes que você não deve perder

ZIP A entrada requer o campo Caminho do Arquivo Markdown
Quando o documento for um arquivo .zip, preencha o caminho do arquivo Markdown com o caminho relativo para o arquivo .md dentro dele, por exemplo. docs/README.mdDeixe em branco para um arquivo .md direto; omita-o em um ZIP A entrada incorreta faz com que o módulo falhe.
A formatação no estilo GitHub é preservada.
Títulos, listas, ênfase em negrito e itálico, código embutido, blocos de código delimitados, tabelas e citações são renderizados corretamente. Imagens referenciadas por um caminho relativo podem não carregar; portanto, use caminhos absolutos. URLs para imagens incorporadas.
Use um iterador para converter um conjunto completo de documentação.
O módulo converte um Markdown um arquivo por execução. Para processar uma pasta de arquivos .md, coloque um Repeater ou Iterator antes deste módulo para que cada iteração processe um arquivo.
O módulo PDF4me Converter Markdown para PDF em Criar exibe os campos Conexão, Nome do Arquivo, Documento e Caminho do Arquivo Markdown.

Selecione o seu PDF4me Conecte-se, mapeie o nome do arquivo e o documento da etapa de download anterior e, em seguida, defina o caminho do arquivo Markdown somente quando o documento for um ZIP arquivo.

O que é Converter? Markdown para PDF em Make?

Converter Markdown para PDF é Make's PDF4me módulo para renderização Markdown fonte para um PDF documentar programaticamente. Aceita um arquivo .md ou um ZIP arquiva como um buffer binário e retorna um formato PDFAo contrário de um conversor online de uso único, este módulo funciona em um cenário automatizado, de modo que cada novo arquivo README, atualização de documentação ou exportação para wiki recebe uma nova conversão. PDF versão sem etapas manuais.

Parâmetros

ParâmetroObrigatórioO que fazExemplo
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

Saída

CampoTipoO que contém
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.

Como funciona a conversão? Markdown para PDF trabalho em Make?

O módulo lê o Markdown O buffer que você mapeia nele renderiza cabeçalhos, listas, tabelas, blocos de código e ênfase em um layout fixo e transmite o resultado de volta como um PDF no campo Dados do Documento. Para um ZIP O comando `input` primeiro extrai o arquivo especificado no caminho do arquivo Markdown e, em seguida, renderiza apenas esse arquivo. Markdown segue o Especificação CommonMark, e a versão do GitHub a estende com tabelas e listas de tarefas, conforme documentado em Guia de Markdown do GitHubPara padrões de construção de cenários, consulte o Acesse a central de ajuda..

Configurações típicas

README em PDF na versão do GitHub
  1. Acionar quando uma nova versão for criada em um repositório do GitHub.
  2. Baixe o arquivo README.md do repositório.
  3. Insira o nome do arquivo e o documento no conversor. Markdown para PDF.
  4. Anexe o documento devolvido PDF aos arquivos de lançamento do GitHub.
Converter em lote uma pasta de documentação
  1. Liste todos os arquivos .md em uma pasta de documentos usando um módulo de listagem do GitLab ou Dropbox.
  2. Percorra a lista e baixe cada arquivo.
  3. Executar Converter Markdown para PDF em cada iteração.
  4. Faça o upload de cada um PDF para um portal de documentação ou unidade compartilhada.
Arquivar uma exportação wiki como PDF
  1. Exportar páginas wiki como um ZIP de Markdown Arquivos do Confluence ou do wiki do GitLab.
  2. Mapeie o ZIP Adicione o buffer ao documento e defina o caminho do arquivo Markdown para a página desejada.
  3. Executar Converter Markdown para PDF para cada caminho de página.
  4. Armazene o resultado PDFem uma pasta de arquivo do Google Drive.

Dicas práticas

Defina o caminho do arquivo Markdown apenas para ZIP entrada
Deixe em branco quando o documento for um arquivo .md direto. Omitir em um ZIP A entrada incorreta faz com que o módulo falhe porque não consegue encontrar um arquivo para renderizar.
Usar imagem absoluta URLs
Caminhos relativos de imagem no Markdown A fonte pode não ser resolvida no momento da renderização. Aponte as referências de imagem para um link completo em https:// URL então eles aparecem no PDF.
Mantenha a extensão do arquivo no nome do arquivo.
Inclua .md ou .zip no nome do arquivo para que o módulo e os módulos subsequentes reconheçam corretamente o formato de origem.
Iterar para vários arquivos
O módulo renderiza um Markdown fonte por execução. Coloque um Repeater ou Iterator antes dele para processar uma pasta inteira de arquivos .md.
Os créditos são consumidos por conversão.
Cada execução consome PDF4me créditos do seu plano. Verifique o uso no seu painel de controle antes de dimensionar uma conversão em lote grande.

Folha de dicas

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)

Perguntas frequentes

Como faço para converter? Markdown para PDF em Make?+
Adicione o PDF4me Converter Markdown para PDF módulo para um Make O módulo cria um cenário, conecta-o, mapeia o nome do arquivo e o documento de uma etapa de download anterior e executa o cenário. O módulo retorna um resultado renderizado. PDF no campo Dados do Documento, sem etapa de conversão manual.
Posso converter um ZIP arquivo de Markdown documentos de uma só vez?+
O módulo converte um Markdown arquivo por execução, mas esse arquivo pode vir de dentro de um ZIP arquivar quando você define o Caminho do Arquivo Markdown para o caminho relativo do arquivo .md no ZIPPara converter uma pasta com arquivos .md separados, execute o módulo uma vez para cada arquivo dentro de um arquivo. Make Iterador.
Por que minhas imagens não aparecem na conversão? PDF?+
Imagens referenciadas por um caminho relativo no Markdown A fonte pode não ser resolvida quando o PDF é renderizado. Use absoluto URLs para imagens incorporadas para que elas carreguem corretamente na saída. PDF. O Guia de Markdown do GitHub Aborda a sintaxe de imagens em detalhes.
Que formatações Markdown o módulo suporta?+
O módulo preserva o estilo do GitHub. Markdown elementos incluindo títulos, listas ordenadas e não ordenadas, ênfase em negrito e itálico, código embutido, blocos de código delimitados, tabelas e citações em bloco, seguindo o Especificação CommonMark que o GitHub Flavored Markdown estende.

Casos de uso e aplicações industriais

  • Documentação READMEConverter arquivos README para PDF para lançamentos
  • Documentação da APIGere documentos PDF a partir de Markdown.
  • Registros de alteraçõesConverter CHANGELOG.md para formato PDF
  • Guias de ContribuiçãoCrie guias em PDF a partir de Markdown.

Ações relacionadas

Mesma tarefa em outras plataformas

Obtenha ajuda