---

Table des matières ⚡

1. Aperçu
   1. Comment Ça Fonctionne
   2. Caractéristiques
2. Installation
   1. Linux
   2. macOS
   3. Windows
3. Mode d'emploi
4. Dépannage
5. Changelog
6. Contributeurs

Aperçu 🔎

Comment Ça Fonctionne

En gérant un seul fichier Base, nous pouvons réduire le nombre d'erreurs causées par des traductions manquantes ou incohérentes. De plus, grâce à l'édition dans un seul fichier, nous pouvons nous attendre à une traduction pratique avec la fonction de complétion automatique des outils AI tels que Copilot.

Markdown:

Jupyter Notebook:

Caractéristiques

Prend en charge les fonctionnalités suivantes :

• Markdown, Jupyter Notebook(.ipynb) comme formats d'entrée
• Tel quel, HTML, PDF comme formats de sortie
• Interface de ligne de commande pour Bash, Zsh, Windows PowerShell
• API Python
• Mode de parcours récursif avec l'option -r (tels quels, HTML, PDF sont tous pris en charge)
• Mode de traitement par lots avec fichier YAML (seul tel quel est pris en charge)
• Étiquette d'identification de langues IETF
• Encodage UTF-8
• Génération automatique de table des matières avec options de niveau et options de emoji (Markdown et Jupyter Notebook sont tous deux pris en charge)
• Validation du fichier de base (Vérifier le nombre de balises de chaque langue)
• Mode validation uniquement pour CI/CD (désactiver la génération de fichiers)

Installation 📦

Linux

pip3 install mmg

macOS

pip3 install mmg

Si vous rencontrez des problèmes avec WeasyPrint, installez-le avec la commande suivante. WeasyPrint est uniquement utilisé pour créer des PDF.

brew install weasyprint

Windows

Python n'est pas installé par défaut sur Windows. Veuillez d'abord installer Python, puis installez MMG à l'aide du gestionnaire de paquets Python pip.

pip3 install mmg

Si vous avez installé Python depuis le Microsoft Store, vous pouvez voir l'avertissement suivant lors de l'installation de MMG. (Le chemin affiché peut varier selon l'utilisateur.)

$ pip3 install mmg
...
  WARNING: The script mmg.exe is installed in 'C:\Users\...\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.11_qbz5n2kfra8p0\LocalCache\local-packages\Python311\Scripts' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed mmg-2.0.1

Si vous voyez cet avertissement, cela signifie que la commande mmg ne peut pas être trouvée dans le terminal. Veuillez ajouter le chemin indiqué dans le message d'avertissement à la variable d'environnement PATH. Les instructions pour ajouter au PATH se trouvent dans la documentation Dépannage.

En plus, MMG utilise WeasyPrint pour créer des PDF. WeasyPrint nécessite la bibliothèque GTK, alors téléchargez et exécutez le dernier installateur GTK3. Si vous n'êtes pas intéressé par la création de PDF, vous pouvez ignorer cette étape. Les autres fonctionnalités de MMG sont disponibles sans GTK.

Mode d'emploi 💡

Veuillez vous référer à la documentation pour plus de détails sur l'utilisation et des exemples.

$ mmg --help
Usage: mmg [OPTIONS] [FILE_NAMES]...

  FILE_NAMES: Base file names to convert.

  Supported extensions are:
      .md, .markdown, .mkd (Markdown)
      .mdx (MDX - Markdown + JSX) [experimental]
      .rmd (R Markdown) [experimental]
      .mmd (MultiMarkdown) [experimental]
      .qmd (Quarto) [experimental]
      .ipynb (Jupyter Notebook)

  Here are some examples:
      mmg *.base.md
      mmg *.base.ipynb
      mmg *.base.md *.base.ipynb -o pdf --css github-dark
      mmg --recursive
      mmg --recursive --validation-only
      mmg --batch mmg.yml

Options:
  -r, --recursive                 This will search all subfolders based on
                                  current directory.
  -b, --batch FILE                YAML file path for batch conversion.
                                  (Default: None)
  -o, --output-format [as-is|html|pdf]
                                  Output format. (Default: as-is)
  --css TEXT                      CSS file path or preset('github-
                                  light'/'github-dark'). Only for the HTML/PDF
                                  output. (Default: github-light)
  -y, --yes                       This will confirm the conversion without
                                  asking. (Default: False)
  -s, --skip-validation           Skip the health check. (Default: False)
  --validation-only               Only check the health. (Default: False)
  -v, --verbose                   Verbosity level from 0 to 2. --verbose:1,
                                  -v:1, -vv:2 (Default: 0)
  --version                       Show the current version.
  --help                          Show this message and exit.

Dépannage 💊

Veuillez vous référer à la page dépannage sur le site web.

Changelog 📝

CHANGELOG.md

Contributeurs 🤝

Réalisé avec contrib.rocks.

Si vous êtes intéressé par la façon de contribuer, veuillez vous référer au guide de contribution.