YAML ファイルを使用したバッチ処理

English | Français | 한국어 | 日本語

v2.0.0 から使える機能です。

YAML ファイルにはより複雑な MMG の処理を定義できます。

• 指定したフォルダにログファイルを残せます。
• ユーザー定義タグをファイルの接尾辞ではなく、フォルダ名として使えます。例えば、foo.en.md と foo.fr.md の代わりに、en/foo.md と fr/foo.md を生成できます。
• 生成されるファイルのディレクトリを指定できます。

今ご覧のページも mmg.yaml を使用して MkDocs static i18n plugin が認識できる形式に変換されました。

使い方

作業を定義したファイルが my_first_job.yaml なら、次のように実行できます。

mmg -b my_first_job.yaml

YAML ファイルの例

convert_without_ask: true
# If false (default), ask for confirmation before converting.
# If true, it is same as `mmg ** --yes`.`

verbose: 2
# 0: quiet(default), 1: normal, 2: verbose

log_dir: "logs"
# Log files will be placed in this folder.
# If the folder does not exist, error will occur.
# If comment out, log files will not be generated.

# The `tags_as` can be "folder" or "suffix"
#   - "folder" is for the folder docs structure.
#   - "suffix" is for the suffix docs structure
# Please refer to the following link for details.
# https://ultrabug.github.io/mkdocs-static-i18n/getting-started/quick-start/

jobs:
  - name: "MkDocs pages"        # Job name (optional)
    tag_as: "folder"            # "folder" or "suffix" (required)
    source: "docs/base"         # Source folder containing the files to convert (required)
    recursive: true             # If true, recursively search for files in subfolders (default: true)
    output_dir: "docs"          # Generated files will be placed in this folder (required)

  - name: "README.md"           # Job name (optional)
    tag_as: "suffix"            # "folder" or "suffix" (required)
    source: "README.base.md"    # Source file to convert (required)
    output_dir: "./"            # Generated file will be placed in this folder (required)