MDPress

Markdown do GitHub para PDF

README para PDF de qualquer projeto do GitHub

Um README é escrito para ser lido no GitHub, mas às vezes precisa circular como arquivo: uma transição para um cliente, uma pasta de conformidade, um trabalho da faculdade. O MDPress lê o mesmo Markdown no estilo GitHub, então listas de tarefas, tabelas e código em blocos saem como um PDF paginado com código realçado e texto selecionável.

Abrir o conversor

Converta um README do GitHub para PDF em três passos.

  1. 01

    Obtenha o Markdown em texto puro

    Abra o README.md no GitHub e clique no botão Raw, ou use o ícone de copiar arquivo bruto ao lado dele. Se você já tem o repositório clonado, o arquivo já está no seu disco.

  2. 02

    Cole ou envie o arquivo

    Cole o texto no editor, ou escolha Importar Markdown e abra o arquivo .md. A pré-visualização em tempo real mostra cada seção em páginas reais, então você percebe uma imagem faltando ou uma linha de código longa antes de exportar.

  3. 03

    Defina a página e baixe

    O estilo Técnico numera as seções e dá espaço aos blocos de código, o que combina com documentação. Escolha A4 ou US Letter, ative uma página de sumário se o README for longo, e baixe.

Um README pequeno, pronto para converter.

Cole um arquivo como este e cada parte dele passa para o PDF.

# tinycache

Um cache pequeno em memória para Node.js com expiração baseada em tempo.

## Instalação

```bash
npm install tinycache
```

## Uso

```js
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
```

## Roteiro

- [x] Expiração por chave
- [ ] Limite de tamanho

tinycache

Um cache pequeno em memória para Node.js com expiração baseada em tempo.

Instalação

npm install tinycache

Uso

import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });

Roteiro

  • Expiração por chave
  • Limite de tamanho

Por que converter um README aqui.

Lê Markdown no estilo GitHub

Listas de tarefas, tabelas com pipes, código em blocos com marcador de linguagem, links automáticos e texto tachado são todos reconhecidos, porque o conversor segue a mesma variante que o GitHub usa. Um bloco mermaid é desenhado como diagrama, assim como na página do repositório.

Código que continua legível no papel

Comandos de instalação e amostras de configuração recebem realce por linguagem. Uma linha mais larga que a página quebra dentro do próprio bloco em vez de sair da margem, então ninguém precisa adivinhar o fim de um comando longo.

Um sumário a partir dos seus títulos

READMEs longos já têm um esboço nos seus títulos. A ferramenta Sumário lista os três primeiros níveis de título em uma página no início, com números de página, e a ferramenta Capa adiciona uma página de título com o nome do projeto, o autor e a data.

Dicas e limites honestos.

  • Caminhos relativos de imagem, como docs/screenshot.png, não vão carregar, porque o conversor não vê o seu repositório. Envie a imagem pela ferramenta Imagens, ou troque o caminho pelo endereço completo da imagem na web.
  • HTML bruto aparece como texto e não é renderizado. Muitos READMEs usam HTML para um logo centralizado, selos em fileira ou uma seção recolhível, então reescreva essas partes em Markdown puro ou remova-as.
  • Links relativos para outros arquivos do repositório, como CONTRIBUTING.md, não levam a lugar nenhum dentro de um PDF. Troque-os por endereços completos do GitHub antes de exportar.

Perguntas sobre README para PDF.

Posso colar um link do GitHub e converter o README direto?
Não. O MDPress não busca repositórios. Abra o README no GitHub, clique em Raw, copie o texto e cole, ou envie o arquivo README.md do seu clone. Leva alguns segundos e também funciona para repositórios privados, já que você mesmo fornece o texto.
Por que as imagens estão faltando no PDF do meu README?
O README provavelmente aponta para imagens com caminhos relativos, que só funcionam dentro do repositório. Adicione cada imagem pela ferramenta Imagens para incorporá-la ao documento, ou aponte para um endereço absoluto na web. Imagens incorporadas contam no limite de 4 MB.
Selos e blocos de HTML em um README funcionam?
Selos escritos como sintaxe de imagem do Markdown com um endereço completo na web carregam como qualquer outra imagem. Tudo escrito como marcação HTML é impresso como texto literal, então um cabeçalho centralizado ou uma seção de detalhes precisa ser convertido para Markdown primeiro.

Transforme o README em um arquivo que você pode enviar.

Cole o Markdown em texto puro ou envie o README.md, confira a pré-visualização e baixe. Nenhuma conta é necessária para os primeiros quatro PDFs de cada dia.

Abrir o conversor