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.
This commit is contained in:
@@ -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,15 +18,15 @@ npm install
|
||||
node md-to-pdf.js <fichier.md>
|
||||
```
|
||||
|
||||
Le PDF est généré dans `output/<fichier>.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/<fichier>.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
|
||||
@@ -30,10 +34,3 @@ node md-to-pdf.js rapport.md /tmp/rapport.pdf
|
||||
- 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 |
|
||||
|
||||
Reference in New Issue
Block a user