From 39089e2f1dab0ea5dcd723a1d17d1108ad2e446f Mon Sep 17 00:00:00 2001 From: Hyko Date: Wed, 15 Apr 2026 11:40:09 -0400 Subject: [PATCH] docs: simplify and clarify README content Reword descriptions for conciseness, add a prerequisites section for Node.js, and remove the dependencies table to reduce noise. --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 419b955..c54994c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # markdown-to-pdf -Convertit un fichier Markdown en PDF bien mis en forme — fond blanc, typographie soignée, sans coupures de page au milieu des tableaux ou des blocs de code. +Convertit un fichier Markdown en PDF bien mis en forme. Fond blanc, typographie soignée, sans coupures de page au milieu des tableaux ou des blocs de code. + +## Prérequis + +Node.js installé. ## Installation @@ -14,26 +18,19 @@ npm install node md-to-pdf.js ``` -Le PDF est généré dans `output/.pdf`, à côté du fichier source. Le dossier `output/` est créé automatiquement s'il n'existe pas. +Le PDF est généré dans `output/.pdf`. Le dossier `output/` est créé automatiquement s'il n'existe pas. -Un chemin de sortie personnalisé peut être fourni en second argument : +Pour choisir un chemin de sortie différent : ```bash node md-to-pdf.js rapport.md /tmp/rapport.pdf ``` -## Fonctionnalités +## Ce que le script gère - Tableaux, blocs de code, citations et images jamais coupés entre deux pages - Les titres ne se retrouvent pas seuls en bas de page - Lignes alternées sur les tableaux - Code inline et en blocs avec police monospace et fond discret - Citations avec bordure bleue à gauche -- Format A4 avec marges adaptées - -## Dépendances - -| Package | Rôle | -|---------|------| -| [`marked`](https://github.com/markedjs/marked) | Markdown → HTML | -| [`puppeteer`](https://github.com/puppeteer/puppeteer) | HTML → PDF via Chromium headless | +- Format A4 avec marges adaptées \ No newline at end of file