AuraDoc
Iniciar sessãoCriar

Como converter o README de um projeto em PDF

Um README fica bonito num site de alojamento de código, mas clientes, auditores e departamentos de compras pedem muitas vezes a documentação do projeto em PDF para arquivar. Este guia transforma o ficheiro Markdown num documento arrumado, sem ferramentas de compilação.

O PDF mantém a estrutura do README, por isso títulos, listas, tabelas e blocos de código aparecem como o autor os pensou.

Passo a passo

  1. Obter o ficheiro README

    Descarregue o README.md do repositório ou grave-o a partir do seu editor. São aceites ficheiros até 1 MB.

  2. Converter

    Abra README em PDF e escolha o ficheiro. Não há opções; títulos, listas, tabelas e blocos de código são paginados automaticamente.

  3. Verificar as imagens

    As imagens que apontam para um endereço na internet não são carregadas. Se o README depende de capturas de ecrã, acrescente-as mais tarde como páginas separadas.

  4. Juntar a outros documentos

    Abra Juntar PDF e adicione o PDF do README a outros ficheiros, como uma licença, um registo de alterações ou um diagrama de arquitetura.

  5. Numerar as páginas

    Abra Numerar páginas do PDF e escolha um formato e uma posição, para que os revisores possam indicar páginas exatas.

Ferramentas usadas neste guia

Perguntas sobre esta tarefa

Posso converter vários ficheiros Markdown?
Converta cada ficheiro à parte e depois junte os resultados com Juntar PDF pela ordem que quiser.
Os emblemas e as imagens remotas aparecem?
Não. As imagens ligadas a partir da internet são ignoradas, por isso os emblemas desaparecem. O texto à volta mantém-se.
O README é enviado para um servidor?
A conversão decorre num servidor seguro que apaga o ficheiro assim que o PDF é enviado. Juntar e numerar funcionam no navegador.

Termos de PDF explicados

Mais guias

Precisa de mais do que uma correção rápida?

O AuraDoc é uma plataforma de documentos com OCR, pesquisa e resumos com IA e mais de 60 ferramentas de PDF para equipas. Experimente gratuitamente durante 7 dias.

As ferramentas marcadas como “Servidor protegido” enviam o seu ficheiro uma única vez, por ligação cifrada, para um servidor isolado da AuraDoc. É tratado num processo descartável e eliminado assim que o resultado lhe é devolvido. Política de utilização justa e antiabuso