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)