---

目次 ⚡

1. 概要
   1. 作動方式
   2. 特徴
2. 設置
   1. Linux
   2. macOS
   3. Windows
3. 使用方法
4. トラブルシューティング
5. Changelog
6. 貢献された方々

概要 🔎

作動方式

1 つの Base ファイルのみを管理することで、コンテンツの翻訳漏れや不一致によるエラーを減らすことができます。 また、単一ファイルで編集できるため、Copilot などの AI ツールの自動補完機能による便利な翻訳を期待できます。

Markdown:

Jupyter Notebook:

特徴

次の機能をサポートします。

• Markdown、Jupyter Notebook（.ipynb）を入力形式で使用する
• As-is(そのまま)、HTML、PDF出力形式
• Bash、Zsh、Windows PowerShell用のコマンドラインインターフェイス
• Python API
• -rオプションを使用した再帰巡回モード（As-is、HTML、PDFの両方をサポート）
• YAMLファイルを使用したバッチモード（As-isのみサポート）
• IETF言語タグ
• UTF-8エンコーディング
• レベルと絵文字オプションを含む目次の自動生成（MarkdownとJupyter Notebookの両方をサポート）
• Baseファイルの検証(言語別のタグ数の確認)
• CI / CDのための検証のみモード（ファイル生成を無効にする）

設置 📦

Linux

pip3 install mmg

macOS

pip3 install mmg

WeasyPrintで問題が発生した場合は、次のコマンドでインストールしてください。WeasyPrintはPDFの作成にのみ使用されます。

brew install weasyprint

Windows

WindowsにはPythonがデフォルトでインストールされていません。Pythonをインストールした後、PythonパッケージマネージャーpipでMMGをインストールしてください。

pip3 install mmg

Microsoft StoreからPythonをインストールした場合、MMGのインストール時に次の警告が表示される場合があります。（表示されるパスはユーザーごとに異なる場合があります。）

$ 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

この警告が表示された場合、ターミナルでmmgコマンドが見つからない状態です。警告メッセージに表示されているパスを環境変数PATHに追加してください。追加方法はトラブルシューティングドキュメントに記載されています。

追加的に、MMGはWeasyPrintを使用してPDFを作成します。WeasyPrintはGTKライブラリが必要なので、最新のGTK3インストーラーをダウンロードして実行します。PDFを作成することに興味がない場合は、このステップをスキップできます。 GTKがなくても、MMGの他の機能は使用できます。

使用方法 💡

詳細な使用方法と例は、ドキュメントを参照してください。

$ 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.

トラブルシューティング 💊

トラブルシューティングページを参照してください。

Changelog 📝

CHANGELOG.md

貢献された方々 🤝

contrib.rocksで作りました。

貢献方法に興味がある方は、貢献ガイドを参照してください。