docs: add full README with usage and feature documentation
Add comprehensive README in French covering installation, CLI usage with optional output path, feature list (pagination, table styling, code blocks, blockquotes), and a dependency table for `marked` and `puppeteer`.
This commit is contained in:
@@ -1,2 +1,39 @@
|
|||||||
# markdown-to-pdf
|
# 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.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
## Utilisation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
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.
|
||||||
|
|
||||||
|
Un chemin de sortie personnalisé peut être fourni en second argument :
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node md-to-pdf.js rapport.md /tmp/rapport.pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fonctionnalités
|
||||||
|
|
||||||
|
- 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 |
|
||||||
|
|||||||
Reference in New Issue
Block a user