MDPress

Markdown GitHub en PDF

README en PDF pour tout projet GitHub

Un README est écrit pour être lu sur GitHub, mais il doit parfois voyager comme fichier : une remise à un client, un dossier de conformité, un devoir de cours. MDPress lit le même Markdown au format GitHub, si bien que listes de tâches, tableaux et code encadré deviennent un PDF paginé avec du code coloré et du texte sélectionnable.

Ouvrir le convertisseur

Convertir un README GitHub en PDF en trois étapes.

  1. 01

    Récupérer le Markdown brut

    Ouvrez README.md sur GitHub et cliquez sur le bouton Raw, ou utilisez l’icône de copie du fichier brut à côté. Si vous avez cloné le dépôt, le fichier est déjà sur votre disque.

  2. 02

    Le coller ou l’importer

    Collez le texte dans l’éditeur, ou choisissez Importer un Markdown et ouvrez le fichier .md. L’aperçu en direct montre chaque section sur de vraies pages, pour repérer une image manquante ou une longue ligne de code avant d’exporter.

  3. 03

    Régler la page et télécharger

    Le style Technique numérote les sections et laisse de l’espace aux blocs de code, ce qui convient à la documentation. Choisissez A4 ou US Letter, activez un sommaire si le README est long, puis téléchargez.

Un petit README, prêt à convertir.

Collez un fichier comme celui-ci et chaque partie se retrouve dans le PDF.

# tinycache

Un petit cache en mémoire pour Node.js avec expiration temporisée.

## Installation

```bash
npm install tinycache
```

## Utilisation

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

## Feuille de route

- [x] Expiration par clé
- [ ] Limite de taille

tinycache

Un petit cache en mémoire pour Node.js avec expiration temporisée.

Installation

npm install tinycache

Utilisation

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

Feuille de route

  • Expiration par clé
  • Limite de taille

Pourquoi convertir un README ici.

Il lit le Markdown au format GitHub

Listes de tâches, tableaux à pipes, code encadré avec une étiquette de langage, liens automatiques et texte barré sont tous compris, car le convertisseur suit le même format que GitHub. Un bloc mermaid est dessiné comme un diagramme, comme sur la page du dépôt.

Du code qui reste lisible sur papier

Les commandes d’installation et les exemples de configuration sont colorés selon le langage. Une ligne plus large que la page passe à la ligne dans son bloc au lieu de dépasser, personne n’a donc à deviner la fin d’une longue commande.

Un sommaire créé à partir de vos titres

Les longs README ont déjà un plan dans leurs titres. L’outil Sommaire liste les trois premiers niveaux de titre sur une page au début, avec les numéros de page, et l’outil Couverture ajoute une page de titre avec le nom du projet, l’auteur et la date.

Conseils et limites honnêtes.

  • Les chemins d’image relatifs comme docs/screenshot.png ne se chargeront pas, car le convertisseur ne voit pas votre dépôt. Ajoutez l’image avec l’outil Images, ou remplacez le chemin par l’adresse web complète de l’image.
  • Le HTML brut est affiché comme texte et n’est pas interprété. De nombreux README utilisent du HTML pour un logo centré, des badges en ligne ou une section repliable, réécrivez donc ces parties en Markdown simple ou supprimez-les.
  • Les liens relatifs vers d’autres fichiers du dépôt, comme CONTRIBUTING.md, ne mènent nulle part dans un PDF. Remplacez-les par des adresses GitHub complètes avant d’exporter.

Questions sur README en PDF.

Puis-je coller un lien GitHub et convertir le README directement ?
Non. MDPress ne récupère pas les dépôts. Ouvrez le README sur GitHub, cliquez sur Raw, copiez le texte et collez-le, ou importez le fichier README.md depuis votre clone. Cela prend quelques secondes et fonctionne aussi pour les dépôts privés, puisque vous fournissez le texte vous-même.
Pourquoi les images manquent-elles dans mon README en PDF ?
Le README pointe probablement vers des images avec des chemins relatifs, qui ne se résolvent qu’à l’intérieur du dépôt. Ajoutez chaque image avec l’outil Images pour qu’elle soit intégrée au document, ou reliez-la à une adresse web absolue. Les images intégrées comptent dans la limite de 4 Mo.
Les badges et blocs HTML d’un README fonctionnent-ils ?
Les badges écrits en syntaxe d’image Markdown avec une adresse web complète se chargent comme toute autre image. Tout ce qui est écrit en balises HTML est imprimé comme texte littéral, un en-tête centré ou une section détails doit donc d’abord être converti en Markdown.

Faites du README un fichier à envoyer.

Collez le Markdown brut ou importez README.md, vérifiez l’aperçu et téléchargez. Aucun compte n’est requis pour les quatre premiers PDF de la journée.

Ouvrir le convertisseur