Init project

2026-06-04 08:30:34 +02:00
commit 1265beefb8
1625 changed files with 208085 additions and 0 deletions
@@ -0,0 +1,52 @@
+# md-render
+
+Convertisseur Markdown → HTML en ligne de commande avec prévisualisation live.
+
+## Installation
+
+```bash
+npm install
+npm link   # rend la commande md-render disponible globalement
+```
+
+## Utilisation
+
+```bash
+# Conversion simple (génère un fichier .html)
+md-render README.md
+
+# Conversion vers un fichier spécifique
+md-render README.md -o documentation.html
+
+# Mode watch — ouvre http://localhost:3000 dans votre navigateur
+md-render README.md --watch
+
+# Mode watch sur un port personnalisé
+md-render README.md --watch --port 8080
+```
+
+## Options
+
+| Option              | Alias | Description                                 | Défaut |
+|---------------------|-------|---------------------------------------------|--------|
+| `--watch`           | `-w`  | Lance le serveur avec rechargement auto     | —      |
+| `--port <port>`     | `-p`  | Port du serveur en mode watch               | `3000` |
+| `--output <fichier>`| `-o`  | Fichier HTML de sortie                      | `<input>.html` |
+| `--help`            | `-h`  | Affiche l'aide                              | —      |
+
+## Mode watch
+
+En mode `--watch`, un serveur HTTP est démarré localement. Ouvrez `http://localhost:3000`
+dans votre navigateur. À chaque sauvegarde du fichier Markdown, la page se recharge automatiquement
+via une connexion SSE (Server-Sent Events).
+
+Les assets relatifs (images, etc.) placés dans le même répertoire que le `.md` sont servis automatiquement.
+
+## Fonctionnalités
+
+- 🎨 Coloration syntaxique du code (highlight.js)
+- 📄 Style GitHub-like
+- 🔄 Rechargement automatique en mode watch
+- 🖼 Serveur de fichiers statiques pour les images locales
+- ⚡ Debounce intelligent pour éviter les rechargements en rafale
+- 🛡 Protection contre le path traversal